diff --git a/src/Essentials/docs/Microsoft.Maui.Essentials/Contact.xml b/src/Essentials/docs/Microsoft.Maui.Essentials/Contact.xml deleted file mode 100644 index 531997e40753..000000000000 --- a/src/Essentials/docs/Microsoft.Maui.Essentials/Contact.xml +++ /dev/null @@ -1,251 +0,0 @@ - - - - - - Microsoft.Maui.Essentials - 1.0.0.0 - - - System.Object - - - - This type contains information about a particular contact. - - - - - - - - Constructor - - Microsoft.Maui.Essentials - 1.0.0.0 - - - - Constructs a new instance of . - - - - - - - - Constructor - - Microsoft.Maui.Essentials - 1.0.0.0 - - - - - - - - - - - - - - The identifier of the contact. - The prefix of the contact. - The given name or first name of the contact. - The middle name(s) of the contact. - The family name or last name of the contact. - The suffix of the contact. - A collection of phone numbers for the contact. - A collection of email addresses for the contact. - The display name of the contact. - Constructs a new instance of using the various parameters. - - - - - - - - Property - - Microsoft.Maui.Essentials - 1.0.0.0 - - - System.String - - - Gets or sets the display name of the contact. - - - - - - - - - Property - - Microsoft.Maui.Essentials - 1.0.0.0 - - - System.Collections.Generic.List<Microsoft.Maui.ApplicationModel.Communication.ContactEmail> - - - Gets or sets a collection of email addresses of the contact. - - - - - - - - - Property - - Microsoft.Maui.Essentials - 1.0.0.0 - - - System.String - - - Gets or sets the family name or last name of the contact. - - - - - - - - - Property - - Microsoft.Maui.Essentials - 1.0.0.0 - - - System.String - - - Gets or sets the given name or first name of the contact. - - - - - - - - - Property - - Microsoft.Maui.Essentials - 1.0.0.0 - - - System.String - - - Gets or sets the identifier of the contact. - - - - - - - - - Property - - Microsoft.Maui.Essentials - 1.0.0.0 - - - System.String - - - Gets or sets the middle name(s) of the contact. - - - - - - - - - Property - - Microsoft.Maui.Essentials - 1.0.0.0 - - - System.String - - - Gets or sets the name prefix of the contact. - - - - - - - - - Property - - Microsoft.Maui.Essentials - 1.0.0.0 - - - System.String - - - Gets or sets the name suffix of the contact. - - - - - - - - - Property - - Microsoft.Maui.Essentials - 1.0.0.0 - - - System.Collections.Generic.List<Microsoft.Maui.ApplicationModel.Communication.ContactPhone> - - - Gets or sets a collection of phone numbers of the contact. - - - - - - - - - Method - - Microsoft.Maui.Essentials - 1.0.0.0 - - - System.String - - - - - - - - - - - - diff --git a/src/Essentials/docs/Microsoft.Maui.Essentials/ContactEmail.xml b/src/Essentials/docs/Microsoft.Maui.Essentials/ContactEmail.xml deleted file mode 100644 index 1140e02b3208..000000000000 --- a/src/Essentials/docs/Microsoft.Maui.Essentials/ContactEmail.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - Microsoft.Maui.Essentials - 1.0.0.0 - - - System.Object - - - - This type contains information about a particular email address. - - - - - - - - Constructor - - Microsoft.Maui.Essentials - 1.0.0.0 - - - - Constructs a new instance of . - - - - - - - - Constructor - - Microsoft.Maui.Essentials - 1.0.0.0 - - - - - - The email address. - Constructs a new instance of using the various parameters. - - - - - - - - Property - - Microsoft.Maui.Essentials - 1.0.0.0 - - - System.String - - - Gets or sets the email address. - - - - - - - - - Method - - Microsoft.Maui.Essentials - 1.0.0.0 - - - System.String - - - - - - - - - - - - diff --git a/src/Essentials/docs/Microsoft.Maui.Essentials/ContactPhone.xml b/src/Essentials/docs/Microsoft.Maui.Essentials/ContactPhone.xml deleted file mode 100644 index 399a7bf01234..000000000000 --- a/src/Essentials/docs/Microsoft.Maui.Essentials/ContactPhone.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - Microsoft.Maui.Essentials - 1.0.0.0 - - - System.Object - - - - This type contains information about a particular phone number. - - - - - - - - Constructor - - Microsoft.Maui.Essentials - 1.0.0.0 - - - - Constructs a new instance of . - - - - - - - - Constructor - - Microsoft.Maui.Essentials - 1.0.0.0 - - - - - - The phone number. - Constructs a new instance of using the various parameters. - - - - - - - - Property - - Microsoft.Maui.Essentials - 1.0.0.0 - - - System.String - - - Gets or sets the phone number. - - - - - - - - - Method - - Microsoft.Maui.Essentials - 1.0.0.0 - - - System.String - - - - - - - - - - - - diff --git a/src/Essentials/src/Types/Contact.shared.cs b/src/Essentials/src/Types/Contact.shared.cs index 0dd6141b45ee..803b3e4902f3 100644 --- a/src/Essentials/src/Types/Contact.shared.cs +++ b/src/Essentials/src/Types/Contact.shared.cs @@ -3,17 +3,32 @@ namespace Microsoft.Maui.ApplicationModel.Communication { - /// + /// + /// Represents a contact on the user's device. + /// public class Contact { string displayName; - /// + /// + /// Initializes a new instance of the class. + /// public Contact() { } - /// + /// + /// Initializes a new instance of the class with the given data. + /// + /// The identifier of the contact. + /// The prefix of the contact. + /// The given name (or first name) of the contact. + /// The middle name(s) of the contact. + /// The family name (or last name) of the contact. + /// The suffix of the contact. + /// A collection of phone numbers for the contact. + /// A collection of email addresses for the contact. + /// The display name of the contact. public Contact( string id, string namePrefix, @@ -36,38 +51,60 @@ public Contact( DisplayName = displayName; } - /// + /// + /// Gets or sets the identifier of the contact. + /// public string Id { get; set; } - /// + /// + /// Gets or sets the display name of the contact. + /// + /// If no display name is set, a display name is inferred from and . public string DisplayName { get => !string.IsNullOrWhiteSpace(displayName) ? displayName : BuildDisplayName(); private set => displayName = value; } - /// + /// + /// Gets or sets the name prefix of the contact. + /// public string NamePrefix { get; set; } - /// + /// + /// Gets or sets the given name (or first name) of the contact. + /// public string GivenName { get; set; } - /// + /// + /// Gets or sets the middle name(s) of the contact. + /// public string MiddleName { get; set; } - /// + /// + /// Gets or sets the family name (or last name) of the contact. + /// public string FamilyName { get; set; } - /// + /// + /// Gets or sets the name suffix of the contact. + /// public string NameSuffix { get; set; } - /// + /// + /// Gets or sets a collection of phone numbers of the contact. + /// public List Phones { get; set; } = new List(); - /// + /// + /// Gets or sets a collection of email addresses of the contact. + /// public List Emails { get; set; } = new List(); - /// + /// + /// Returns a string representation of the current values of . + /// + /// A string representation of this instance. The return value is the current value of . public override string ToString() => DisplayName; string BuildDisplayName() @@ -81,43 +118,69 @@ string BuildDisplayName() } } + /// + /// Represents an email address that is associated with a . + /// public class ContactEmail { - /// + /// + /// Initializes a new instance of the class. + /// public ContactEmail() { } - /// + /// + /// Initializes a new instance of the class with the given data. + /// + /// The email address. public ContactEmail(string emailAddress) { EmailAddress = emailAddress; } - /// + /// + /// Gets or sets the email address. + /// public string EmailAddress { get; set; } - /// + /// + /// Returns a string representation of the current values of . + /// + /// A string representation of this instance. The return value is the current value of . public override string ToString() => EmailAddress; } + /// + /// Represents a phone number that is associated with a . + /// public class ContactPhone { - /// + /// + /// Initializes a new instance of the class. + /// public ContactPhone() { } - /// + /// + /// Initializes a new instance of the class with the given data. + /// + /// The phone number. public ContactPhone(string phoneNumber) { PhoneNumber = phoneNumber; } - /// + /// + /// Gets or sets the phone number. + /// public string PhoneNumber { get; set; } - /// + /// + /// Returns a string representation of the current values of . + /// + /// A string representation of this instance. The return value is the current value of . public override string ToString() => PhoneNumber; } }