namespace Tizen.Messaging.Email
{
/// <summary>
- /// Represents an email attachment
+ /// Represents an email attachment.
/// </summary>
public class EmailAttachment
{
/// <summary>
- /// The absolute full path of the file to be attached
+ /// The absolute full path of the file to be attached.
/// </summary>
public string FilePath { get; set; }
/// <summary>
- /// The constructor
+ /// The constructor.
/// </summary>
public EmailAttachment()
{
namespace Tizen.Messaging.Email
{
/// <summary>
- /// Result of sending the email
+ /// Result of sending the email.
/// </summary>
public enum EmailSendResult
{
/// <summary>
- /// Failed to send the message
+ /// Failed to send the message.
/// </summary>
Failure = -1,
/// <summary>
- /// email sent successfully
+ /// Email sent successfully.
/// </summary>
Success = 0
}
namespace Tizen.Messaging.Email
{
/// <summary>
- /// The class contains Messaging API to support sending email messages.
+ /// This class contains the Messaging API to support sending email messages.
/// </summary>
public class EmailMessage : IDisposable
{
private ICollection<EmailRecipient> _bcc = new Collection<EmailRecipient>();
/// <summary>
- /// The constructor
+ /// The constructor.
/// </summary>
public EmailMessage()
{
}
/// <summary>
- /// Subject of the email message
+ /// The subject of the email message.
/// </summary>
public string Subject
{
}
/// <summary>
- /// Body of the email message
+ /// The body of the email message.
/// </summary>
public string Body
{
}
/// <summary>
- /// List of file attachments
+ /// The list of file attachments.
/// </summary>
public IList<EmailAttachment> Attachments
{
}
/// <summary>
- /// Collection of normal email recipients
+ /// The collection of normal email recipients.
/// </summary>
/// <remarks>
- /// Email address should be in standard format (as described in Internet standards RFC 5321 and RFC 5322).
+ /// The email address should be in the standard format (as described in the Internet standards RFC 5321 and RFC 5322).
/// </remarks>
public ICollection<EmailRecipient> To
{
}
/// <summary>
- /// Collection of CC(carbon copy) email recipients
+ /// The collection of CC (carbon copy) email recipients.
/// </summary>
/// <remarks>
- /// Email address should be in standard format (as described in Internet standards RFC 5321 and RFC 5322).
+ /// The email address should be in the standard format (as described in the Internet standards RFC 5321 and RFC 5322).
/// </remarks>
public ICollection<EmailRecipient> Cc
{
}
/// <summary>
- /// Collection of BCC(blind carbon copy) email recipients
+ /// The collection of BCC (blind carbon copy) email recipients.
/// </summary>
/// <remarks>
- /// Email address should be in standard format (as described in Internet standards RFC 5321 and RFC 5322).
+ /// The email address should be in the standard format (as described in the Internet standards RFC 5321 and RFC 5322).
/// </remarks>
public ICollection<EmailRecipient> Bcc
{
namespace Tizen.Messaging.Email
{
/// <summary>
- /// The class represents recipients of an email
+ /// This class represents recipients of an email.
/// </summary>
public class EmailRecipient
{
/// <summary>
- /// The email address of the recipient
+ /// The email address of the recipient.
/// </summary>
public string Address { get; set; }
/// <summary>
- /// The constructor
+ /// The constructor.
/// </summary>
public EmailRecipient()
{
namespace Tizen.Messaging.Email
{
/// <summary>
- /// The class to send email messages.
+ /// This class is used to send email messages.
/// </summary>
public static class EmailSender
{
/// <summary>
/// Sends the email message.
/// </summary>
- /// <param name="email">The email message</param>
- /// <returns> Failure if email sending failed otherwise Success</returns>
+ /// <param name="email">The email message.</param>
+ /// <returns> Failure if the email sending activity failed, otherwise Success.</returns>
public static async Task<EmailSendResult> SendAsync(EmailMessage email)
{
var task = new TaskCompletionSource<EmailSendResult>();
/// <summary>
-/// The <b>Tizen.Messaging.Email</b> namespace contains classes providing functionality to send emails.
+/// The <b>Tizen.Messaging.Email</b> namespace contains classes providing the functionality to send emails.
/// </summary>
/// <remarks>
-/// The <b>Tizen.Messaging.Email</b> namespace contains classes providing functionality to send emails.
+/// The <b>Tizen.Messaging.Email</b> namespace contains classes providing the functionality to send emails.
/// </remarks>
namespace Tizen.Messaging.Email
{
namespace Tizen.Messaging.Messages
{
/// <summary>
- /// A class to represent cell broadcast messages.
+ /// This class represents the cell broadcast messages.
/// </summary>
public class CBMessage : Message
{
namespace Tizen.Messaging.Messages
{
/// <summary>
- /// A class to represent all messages.
+ /// This class represents all the messages.
/// </summary>
public abstract class Message : IDisposable
{
}
/// <summary>
- /// The message ID
+ /// The message ID.
/// </summary>
/// <remarks>
- /// After creating Message object, default value of this property is 0. After sending, this value is changed.
+ /// After creating the Message object, the default value of this property is 0. After sending, this value is changed.
/// </remarks>
public int Id
{
}
/// <summary>
- /// The destination port of the message
+ /// The destination port of the message.
/// </summary>
public int Port
{
}
/// <summary>
- /// The message box type
+ /// The message box type.
/// </summary>
public MessageBoxType BoxType
{
}
/// <summary>
- /// The text of the message
+ /// The text of the message.
/// </summary>
public string Text
{
}
/// <summary>
- /// The time of the message
+ /// The time of the message.
/// </summary>
public DateTime Time
{
}
/// <summary>
- /// The SIM slot index of the message
+ /// The SIM slot index of the message.
/// </summary>
public SimSlotId SimId
{
}
/// <summary>
- /// Indicates sender of the message
+ /// Indicates the sender of the message.
/// </summary>
public IReadOnlyCollection<MessagesAddress> From
{
namespace Tizen.Messaging.Messages
{
/// <summary>
- /// An extended EventArgs class which contains a received message.
+ /// An extended EventArgs class, which contains a received message.
/// </summary>
public class MessageReceivedEventArgs : EventArgs
{
}
/// <summary>
- /// The received message
+ /// The received message.
/// </summary>
public Message ReceivedMessage
{
namespace Tizen.Messaging.Messages
{
/// <summary>
- /// A class to manage informations of message address.
+ /// This class is used to manage the information of the message address.
/// </summary>
public class MessagesAddress
{
internal RecipientType Type;
/// <summary>
- /// The address of the sender/recipient
+ /// The address of the sender/recipient.
/// </summary>
public string Number { get; }
/// <summary>
/// Creates a message address.
/// </summary>
- /// <param name="number">The recipient's address to receive a message</param>
+ /// <param name="number">The recipient's address to receive a message.</param>
public MessagesAddress(string number)
{
Number = number;
namespace Tizen.Messaging.Messages
{
/// <summary>
- /// A class to manage informations of message attachment.
+ /// This class is used to manage the information of the message attachment.
/// </summary>
public class MessagesAttachment
{
/// <summary>
- /// The media type of attachment
+ /// The media type of the attachment.
/// </summary>
public MediaType Type { get; }
/// <summary>
- /// The file path of attachment
+ /// The file path of the attachment.
/// </summary>
public string FilePath { get; }
/// <summary>
/// Creates an attachment.
/// </summary>
- /// <param name="type">The attachment's type</param>
- /// <param name="filePath">The file path to attach</param>
+ /// <param name="type">The attachment's type.</param>
+ /// <param name="filePath">The file path to attach.</param>
public MessagesAttachment(MediaType type, string filePath)
{
Type = type;
public enum SentResult
{
/// <summary>
- /// Message sending failed
+ /// Message sending failed.
/// </summary>
Failed = -1,
/// <summary>
- /// Message sending succeeded
+ /// Message sending succeeded.
/// </summary>
Success = 0
}
public enum MessageType
{
/// <summary>
- /// Unknown type
+ /// The unknown type.
/// </summary>
Unknown = 0,
/// <summary>
- /// SMS type
+ /// The SMS type.
/// </summary>
Sms = 1,
/// <summary>
- /// MMS type
+ /// The MMS type.
/// </summary>
Mms = 2,
/// <summary>
- /// CB(Cell Broadcast) type
+ /// The CB(Cell Broadcast) type.
/// </summary>
CellBroadcast = Sms | 1 << 4,
/// <summary>
- /// WAP Push type
+ /// The WAP Push type.
/// </summary>
Push = Sms | 10 << 4
}
public enum MessageBoxType
{
/// <summary>
- /// All message box type
+ /// All message box type.
/// </summary>
All = 0,
/// <summary>
- /// Inbox type
+ /// The Inbox type.
/// </summary>
Inbox = 1,
/// <summary>
- /// Outbox type
+ /// The Outbox type.
/// </summary>
Outbox = 2,
/// <summary>
- /// Sentbox type
+ /// The Sentbox type.
/// </summary>
Sentbox = 3,
/// <summary>
- /// Draft type
+ /// The Draft type.
/// </summary>
Draft = 4
}
/// <summary>
- /// Enumeration for the SIM slot index of a message
+ /// Enumeration for the SIM slot index of a message.
/// </summary>
public enum SimSlotId
{
/// <summary>
- /// Unknown SIM Slot
+ /// Unknown SIM Slot.
/// </summary>
Unknown = 0,
/// <summary>
- /// SIM Slot 1
+ /// SIM Slot 1.
/// </summary>
Sim1 = 1,
/// <summary>
- /// SIM Slot 2
+ /// SIM Slot 2.
/// </summary>
Sim2 = 2
}
/// <summary>
- /// Enumeration for the recipient type of a message
+ /// Enumeration for the recipient type of a message.
/// </summary>
internal enum RecipientType
{
/// <summary>
- /// Unknown
+ /// Unknown.
/// </summary>
Unknown = 0,
/// <summary>
- /// 'To' recipient
+ /// 'To' recipient.
/// </summary>
To = 1,
/// <summary>
- /// 'Cc' (carbon copy) recipient
+ /// 'Cc' (carbon copy) recipient.
/// </summary>
Cc = 2,
/// <summary>
- /// 'Bcc' (blind carbon copy) recipient
+ /// 'Bcc' (blind carbon copy) recipient.
/// </summary>
Bcc = 3
}
/// <summary>
- /// Enumeration for the attachment tyoe for MMS messaging.
+ /// Enumeration for the attachment type for the MMS messaging.
/// </summary>
public enum MediaType
{
/// <summary>
- /// Unknown
+ /// Unknown.
/// </summary>
Unknown = 0,
/// <summary>
- /// The image
+ /// The image.
/// </summary>
Image = 1,
/// <summary>
- /// The audio
+ /// The audio.
/// </summary>
Audio = 2,
/// <summary>
- /// The video
+ /// The video.
/// </summary>
Video = 3
}
namespace Tizen.Messaging.Messages
{
/// <summary>
- /// A class for message management. It allows applications to use message service.
+ /// This class is used for the message management. It allows applications to use the message service.
/// </summary>
/// <privilege>http://tizen.org/privilege/message.read</privilege>
public static class MessagesManager
/// Sends a message.
/// </summary>
/// <privilege>http://tizen.org/privilege/message.write</privilege>
- /// <param name="message">The message to be sent</param>
- /// <param name="saveToSentbox">The boolean variable to indicate sent message should be saved in sentbox or not</param>
- /// <returns>A task contains the result of message sending</returns>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
- /// <exception cref="NotSupportedException">Thrown when message service is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when input coordinates are invalid</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
+ /// <param name="message">The message to be sent.</param>
+ /// <param name="saveToSentbox">The boolean variable used to indicate whether the sent message should be saved in the sentbox or not.</param>
+ /// <returns>A task containing the result of message sending.</returns>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the message service is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when input coordinates are invalid.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have proper privileges.</exception>
public static Task<SentResult> SendMessageAsync(Message message, bool saveToSentbox)
{
return MessagesManagerImpl.Instance.SendMessageAsync(message, saveToSentbox);
/// Searches for messages.
/// </summary>
/// <privilege>http://tizen.org/privilege/message.read</privilege>
- /// <param name="filter">The search filter for searching messages</param>
- /// <returns>A task contains the messages which fit with search filter</returns>
- /// <exception cref="InvalidOperationException">Thrown when method failed due to invalid operation</exception>
- /// <exception cref="NotSupportedException">Thrown when message service is not supported</exception>
- /// <exception cref="ArgumentException">Thrown when input coordinates are invalid</exception>
- /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory</exception>
- /// <exception cref="UnauthorizedAccessException">Thrown when application does not have proper privileges</exception>
+ /// <param name="filter">The search filter for searching messages.</param>
+ /// <returns>A task containing the messages, which match the search filter.</returns>
+ /// <exception cref="InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>
+ /// <exception cref="NotSupportedException">Thrown when the message service is not supported.</exception>
+ /// <exception cref="ArgumentException">Thrown when input coordinates are invalid.</exception>
+ /// <exception cref="OutOfMemoryException">Thrown when failed due to out of memory.</exception>
+ /// <exception cref="UnauthorizedAccessException">Thrown when an application does not have proper privileges.</exception>
public static Task<IEnumerable<Message>> SearchMessageAsync(MessagesSearchFilter filter)
{
return MessagesManagerImpl.Instance.SearchMessageAsync(filter);
}
/// <summary>
- /// (event) MessageReceived is raised when receiving a message.
+ /// The MessageReceived event that is raised when receiving a message.
/// </summary>
/// <privilege>http://tizen.org/privilege/message.read</privilege>
static public event EventHandler<MessageReceivedEventArgs> MessageReceived
namespace Tizen.Messaging.Messages
{
/// <summary>
- /// A class to represent message search filters.
+ /// This class represents message search filters.
/// </summary>
public class MessagesSearchFilter
{
/// <summary>
- /// Create a search filter for searching messages.
+ /// Creates a search filter for searching messages.
/// </summary>
public MessagesSearchFilter()
{
}
/// <summary>
- /// The message box type
+ /// The message box type.
/// </summary>
public MessageBoxType MessageBoxType { get; set; }
/// <summary>
- /// The message type
+ /// The message type.
/// </summary>
public MessageType MessageType { get; set; }
/// <summary>
- /// The keyword to search in the text and subject
+ /// The keyword to search in the text and the subject.
/// </summary>
public string TextKeyword { get; set; }
/// <summary>
- /// The recipient address
+ /// The recipient address.
/// </summary>
public string AddressKeyword { get; set; }
}
namespace Tizen.Messaging.Messages
{
/// <summary>
- /// A class to represent multimedia messages.
+ /// This class represents multimedia messages.
/// </summary>
public class MmsMessage : Message
{
}
/// <summary>
- /// The subject of the multimedia message
+ /// The subject of the multimedia message.
/// </summary>
public string Subject
{
}
/// <summary>
- /// Collection of normal message recipients
+ /// The collection of normal message recipients.
/// </summary>
public ICollection<MessagesAddress> To
{
}
/// <summary>
- /// Collection of CC(carbon copy) message recipients
+ /// The collection of CC (carbon copy) message recipients.
/// </summary>
public ICollection<MessagesAddress> Cc
{
}
/// <summary>
- /// Collection of BCC(blind carbon copy) message recipients
+ /// The collection of BCC (blind carbon copy) message recipients.
/// </summary>
public ICollection<MessagesAddress> Bcc
{
}
/// <summary>
- /// The list of attachment files
+ /// The list of attachment files.
/// </summary>
public IList<MessagesAttachment> Attachments
{
*/
/// <summary>
-/// The <b>Tizen.Messaging.Messages</b> namespace contains classes providing functionality to send, receive and search for messages.
+/// The <b>Tizen.Messaging.Messages</b> namespace contains classes providing the functionality to send, receive, and search messages.
/// </summary>
/// <remarks>
-/// The <b>Tizen.Messaging.Messages</b> namespace contains classes providing functionality to send, receive and search for messages.
+/// The <b>Tizen.Messaging.Messages</b> namespace contains classes providing the functionality to send, receive, and search messages.
/// </remarks>
namespace Tizen.Messaging.Messages
{
namespace Tizen.Messaging.Messages
{
/// <summary>
- /// A class to represent WAP push messages.
+ /// This class represents the WAP push messages.
/// </summary>
public class PushMessage : Message
{
namespace Tizen.Messaging.Messages
{
/// <summary>
- /// A class to represent short text messages.
+ /// This class represents short text messages.
/// </summary>
public class SmsMessage : Message
{
}
/// <summary>
- /// Collection of normal message recipients
+ /// The collection of normal message recipients.
/// </summary>
public ICollection<MessagesAddress> To
{
projects / platform / core / csapi / tizenfx.git / commitdiff