diff --git a/src/Essentials/docs/Microsoft.Maui.Essentials/Contacts.xml b/src/Essentials/docs/Microsoft.Maui.Essentials/Contacts.xml deleted file mode 100644 index 8108620ce158..000000000000 --- a/src/Essentials/docs/Microsoft.Maui.Essentials/Contacts.xml +++ /dev/null @@ -1,60 +0,0 @@ - - - - - - Microsoft.Maui.Essentials - 1.0.0.0 - - - System.Object - - - - API class for working with contacts on the device. - - - - - - - - Method - - Microsoft.Maui.Essentials - 1.0.0.0 - - - System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.Maui.ApplicationModel.Communication.Contact>> - - - - - - A token for cancelling the operation - Gets a collection of all the contacts on the device. - Returns a collection of contacts on the device. - - - - - - - - Method - - Microsoft.Maui.Essentials - 1.0.0.0 - - - System.Threading.Tasks.Task<Microsoft.Maui.ApplicationModel.Communication.Contact> - - - - Starts file picker for selecting a single contact. - Returns a single contact, or null if the user cancelled the operation. - - - - - diff --git a/src/Essentials/src/Contacts/Contacts.netstandard.tvos.watchos.cs b/src/Essentials/src/Contacts/Contacts.netstandard.tvos.watchos.cs index 99db6fb3b68e..8dbc3836d5ba 100644 --- a/src/Essentials/src/Contacts/Contacts.netstandard.tvos.watchos.cs +++ b/src/Essentials/src/Contacts/Contacts.netstandard.tvos.watchos.cs @@ -4,7 +4,6 @@ namespace Microsoft.Maui.ApplicationModel.Communication { - /// class ContactsImplementation : IContacts { public Task PickContactAsync() => diff --git a/src/Essentials/src/Contacts/Contacts.shared.cs b/src/Essentials/src/Contacts/Contacts.shared.cs index 161cfb817f02..42ba47ab7077 100644 --- a/src/Essentials/src/Contacts/Contacts.shared.cs +++ b/src/Essentials/src/Contacts/Contacts.shared.cs @@ -5,26 +5,50 @@ namespace Microsoft.Maui.ApplicationModel.Communication { + /// + /// The Contacts API lets a user pick a contact and retrieve information about it. + /// public interface IContacts { + /// + /// Opens the operating system's default UI for picking a contact from the device. + /// + /// A single contact, or if the user cancelled the operation. Task PickContactAsync(); + /// + /// Gets a collection of all the contacts on the device. + /// + /// A token that can be used for cancelling the operation. + /// A collection of contacts on the device. Task> GetAllAsync(CancellationToken cancellationToken = default); } - /// + /// + /// The Contacts API lets a user pick a contact and retrieve information about it. + /// public static class Contacts { - /// + /// + /// Opens the operating system's default UI for picking a contact from the device. + /// + /// A single contact, or if the user cancelled the operation. public static Task PickContactAsync() => Default.PickContactAsync(); - /// + /// + /// Gets a collection of all the contacts on the device. + /// + /// A token that can be used for cancelling the operation. + /// A collection of contacts on the device. public static Task> GetAllAsync(CancellationToken cancellationToken = default) => Default.GetAllAsync(cancellationToken); static IContacts? defaultImplementation; + /// + /// Provides the default implementation for static usage of this API. + /// public static IContacts Default => defaultImplementation ??= new ContactsImplementation();