diff --git a/src/Essentials/docs/Microsoft.Maui.Essentials/Sms.xml b/src/Essentials/docs/Microsoft.Maui.Essentials/Sms.xml
deleted file mode 100644
index 82315bcd4ef4..000000000000
--- a/src/Essentials/docs/Microsoft.Maui.Essentials/Sms.xml
+++ /dev/null
@@ -1,60 +0,0 @@
-
-
-
-
-
- Microsoft.Maui.Essentials
- 1.0.0.0
-
-
- System.Object
-
-
-
- Provides an easy way to allow the user to send SMS messages.
-
-
-
-
-
-
-
- Method
-
- 1.0.0.0
- Microsoft.Maui.Essentials
-
-
- System.Threading.Tasks.Task
-
-
-
- Opens the default SMS client to allow the user to send the message.
-
-
-
-
-
-
-
-
- Method
-
- 1.0.0.0
- Microsoft.Maui.Essentials
-
-
- System.Threading.Tasks.Task
-
-
-
-
-
- The message to send.
- Opens the default SMS client to allow the user to send the message.
-
-
-
-
-
-
diff --git a/src/Essentials/docs/Microsoft.Maui.Essentials/SmsMessage.xml b/src/Essentials/docs/Microsoft.Maui.Essentials/SmsMessage.xml
deleted file mode 100644
index fb8c8a785f86..000000000000
--- a/src/Essentials/docs/Microsoft.Maui.Essentials/SmsMessage.xml
+++ /dev/null
@@ -1,110 +0,0 @@
-
-
-
-
-
- Microsoft.Maui.Essentials
- 1.0.0.0
-
-
- System.Object
-
-
-
- Represents a single SMS message.
-
-
-
-
-
-
-
- Constructor
-
- Microsoft.Maui.Essentials
- 1.0.0.0
-
-
-
- Creates a new instance of SmsMessage
-
-
-
-
-
-
-
- Constructor
-
- Microsoft.Maui.Essentials
- 1.0.0.0
-
-
-
-
-
-
- Content of the message
- Recipients to receive the message.
- Creates a new instance of SmsMessage
-
-
-
-
-
-
-
- Constructor
-
- Microsoft.Maui.Essentials
- 1.0.0.0
-
-
-
-
-
-
- Content of the message
- Recipient to receive the message.
- Creates a new instance of SmsMessage
-
-
-
-
-
-
-
- Property
-
- 1.0.0.0
- Microsoft.Maui.Essentials
-
-
- System.String
-
-
- Gets the body of the message.
-
-
-
-
-
-
-
-
- Property
-
- Microsoft.Maui.Essentials
- 1.0.0.0
-
-
- System.Collections.Generic.List<System.String>
-
-
- Gets the recipient of the message.
-
-
-
-
-
-
diff --git a/src/Essentials/src/Sms/Sms.netstandard.tvos.watchos.cs b/src/Essentials/src/Sms/Sms.netstandard.tvos.watchos.cs
index 73146b23d8c5..7ba40e44818a 100644
--- a/src/Essentials/src/Sms/Sms.netstandard.tvos.watchos.cs
+++ b/src/Essentials/src/Sms/Sms.netstandard.tvos.watchos.cs
@@ -2,7 +2,6 @@
namespace Microsoft.Maui.ApplicationModel.Communication
{
- ///
partial class SmsImplementation : ISms
{
public bool IsComposeSupported
diff --git a/src/Essentials/src/Sms/Sms.shared.cs b/src/Essentials/src/Sms/Sms.shared.cs
index 4510353c648a..c719f4fda509 100644
--- a/src/Essentials/src/Sms/Sms.shared.cs
+++ b/src/Essentials/src/Sms/Sms.shared.cs
@@ -5,21 +5,42 @@
namespace Microsoft.Maui.ApplicationModel.Communication
{
+ ///
+ /// The SMS API enables an application to open the default SMS application with a specified message to send to a recipient.
+ ///
public interface ISms
{
+ ///
+ /// Gets a value indicating whether composing of SMS messages is supported on this device.
+ ///
bool IsComposeSupported { get; }
+ ///
+ /// Opens the default SMS client to allow the user to send the message.
+ ///
+ /// A instance with information about the message to send.
+ /// A object with the current status of the asynchronous operation.
Task ComposeAsync(SmsMessage? message);
}
- ///
+ ///
+ /// The SMS API enables an application to open the default SMS application with a specified message to send to a recipient.
+ ///
+ /// When using this on Android targeting Android 11 (R API 30) you must update your Android Manifest with queries that are used with the new package visibility requirements. See the conceptual docs for more information.
public static class Sms
{
- ///
+ ///
+ /// Opens the default SMS client to allow the user to send the message.
+ ///
+ /// A object with the current status of the asynchronous operation.
public static Task ComposeAsync()
=> Current.ComposeAsync(null);
- ///
+ ///
+ /// Opens the default SMS client to allow the user to send the message.
+ ///
+ /// A instance with information about the message to send.
+ /// A object with the current status of the asynchronous operation.
public static Task ComposeAsync(SmsMessage? message)
=> Current.ComposeAsync(message);
@@ -27,6 +48,9 @@ public static Task ComposeAsync(SmsMessage? message)
static ISms? defaultImplementation;
+ ///
+ /// Provides the default implementation for static usage of this API.
+ ///
public static ISms Default =>
defaultImplementation ??= new SmsImplementation();
@@ -52,15 +76,23 @@ public Task ComposeAsync(SmsMessage? message)
}
}
- ///
+ ///
+ /// Represents a single SMS message.
+ ///
public class SmsMessage
{
- ///
+ ///
+ /// Initializes a new instance of the class.
+ ///
public SmsMessage()
{
}
- ///
+ ///
+ /// Initializes a new instance of the class.
+ ///
+ /// The body text that is used to prefill the composed SMS message.
+ /// A single recipient that is added to the composed SMS message.
public SmsMessage(string body, string? recipient)
{
Body = body;
@@ -68,7 +100,12 @@ public SmsMessage(string body, string? recipient)
Recipients.Add(recipient!);
}
- ///
+ ///
+ /// Initializes a new instance of the class.
+ ///
+ /// The body text that is used to prefill the composed SMS message.
+ /// A collection of recipients that are added to the composed SMS message.
+ /// Values in that are or whitespace are not added as recipients.
public SmsMessage(string body, IEnumerable? recipients)
{
Body = body;
@@ -78,10 +115,14 @@ public SmsMessage(string body, IEnumerable? recipients)
}
}
- ///
+ ///
+ /// Gets or sets the body of this message.
+ ///
public string? Body { get; set; }
- ///
+ ///
+ /// Gets or sets the recipients for this message.
+ ///
public List Recipients { get; set; } = new List();
}
}