From f72f0f4a1ca51575cae13622daedbd57711903ee Mon Sep 17 00:00:00 2001 From: Jeesun Kim Date: Wed, 6 Sep 2017 14:38:08 +0900 Subject: [PATCH] [Email] Review messaging API cs files Change-Id: If665973bc15871c68ff3b8f6afc629e763f73117 --- .../Tizen.Messaging.Email/EmailAttachment.cs | 6 +-- .../Tizen.Messaging.Email/EmailEnumerations.cs | 6 +-- .../Tizen.Messaging.Email/EmailMessage.cs | 22 ++++----- .../Tizen.Messaging.Email/EmailRecipient.cs | 6 +-- .../Tizen.Messaging.Email/EmailSender.cs | 6 +-- .../Tizen.Messaging.Email/NamespaceDoc.cs | 4 +- .../Tizen.Messaging.Messages/CBMessage.cs | 2 +- .../Tizen.Messaging.Messages/Message.cs | 18 ++++---- .../MessageReceivedEventArgs.cs | 4 +- .../Tizen.Messaging.Messages/MessagesAddress.cs | 6 +-- .../Tizen.Messaging.Messages/MessagesAttachment.cs | 10 ++--- .../MessagesEnumerations.cs | 52 +++++++++++----------- .../Tizen.Messaging.Messages/MessagesManager.cs | 32 ++++++------- .../MessagesSearchFilter.cs | 12 ++--- .../Tizen.Messaging.Messages/MmsMessage.cs | 12 ++--- .../Tizen.Messaging.Messages/NamespaceDoc.cs | 4 +- .../Tizen.Messaging.Messages/PushMessage.cs | 2 +- .../Tizen.Messaging.Messages/SmsMessage.cs | 4 +- 18 files changed, 104 insertions(+), 104 deletions(-) diff --git a/src/Tizen.Messaging/Tizen.Messaging.Email/EmailAttachment.cs b/src/Tizen.Messaging/Tizen.Messaging.Email/EmailAttachment.cs index 5f8028a..357e144 100644 --- a/src/Tizen.Messaging/Tizen.Messaging.Email/EmailAttachment.cs +++ b/src/Tizen.Messaging/Tizen.Messaging.Email/EmailAttachment.cs @@ -17,16 +17,16 @@ namespace Tizen.Messaging.Email { /// - /// Represents an email attachment + /// Represents an email attachment. /// public class EmailAttachment { /// - /// The absolute full path of the file to be attached + /// The absolute full path of the file to be attached. /// public string FilePath { get; set; } /// - /// The constructor + /// The constructor. /// public EmailAttachment() { diff --git a/src/Tizen.Messaging/Tizen.Messaging.Email/EmailEnumerations.cs b/src/Tizen.Messaging/Tizen.Messaging.Email/EmailEnumerations.cs index fdeaa37..45fa335 100755 --- a/src/Tizen.Messaging/Tizen.Messaging.Email/EmailEnumerations.cs +++ b/src/Tizen.Messaging/Tizen.Messaging.Email/EmailEnumerations.cs @@ -17,17 +17,17 @@ namespace Tizen.Messaging.Email { /// - /// Result of sending the email + /// Result of sending the email. /// public enum EmailSendResult { /// - /// Failed to send the message + /// Failed to send the message. /// Failure = -1, /// - /// email sent successfully + /// Email sent successfully. /// Success = 0 } diff --git a/src/Tizen.Messaging/Tizen.Messaging.Email/EmailMessage.cs b/src/Tizen.Messaging/Tizen.Messaging.Email/EmailMessage.cs index f7756c9..e4b9d9f 100644 --- a/src/Tizen.Messaging/Tizen.Messaging.Email/EmailMessage.cs +++ b/src/Tizen.Messaging/Tizen.Messaging.Email/EmailMessage.cs @@ -21,7 +21,7 @@ using System.Collections.ObjectModel; namespace Tizen.Messaging.Email { /// - /// The class contains Messaging API to support sending email messages. + /// This class contains the Messaging API to support sending email messages. /// public class EmailMessage : IDisposable { @@ -35,7 +35,7 @@ namespace Tizen.Messaging.Email private ICollection _bcc = new Collection(); /// - /// The constructor + /// The constructor. /// public EmailMessage() { @@ -48,7 +48,7 @@ namespace Tizen.Messaging.Email } /// - /// Subject of the email message + /// The subject of the email message. /// public string Subject { @@ -70,7 +70,7 @@ namespace Tizen.Messaging.Email } /// - /// Body of the email message + /// The body of the email message. /// public string Body { @@ -91,7 +91,7 @@ namespace Tizen.Messaging.Email } /// - /// List of file attachments + /// The list of file attachments. /// public IList Attachments { @@ -102,10 +102,10 @@ namespace Tizen.Messaging.Email } /// - /// Collection of normal email recipients + /// The collection of normal email recipients. /// /// - /// 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). /// public ICollection To { @@ -116,10 +116,10 @@ namespace Tizen.Messaging.Email } /// - /// Collection of CC(carbon copy) email recipients + /// The collection of CC (carbon copy) email recipients. /// /// - /// 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). /// public ICollection Cc { @@ -130,10 +130,10 @@ namespace Tizen.Messaging.Email } /// - /// Collection of BCC(blind carbon copy) email recipients + /// The collection of BCC (blind carbon copy) email recipients. /// /// - /// 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). /// public ICollection Bcc { diff --git a/src/Tizen.Messaging/Tizen.Messaging.Email/EmailRecipient.cs b/src/Tizen.Messaging/Tizen.Messaging.Email/EmailRecipient.cs index 3c1fc24..99d5de3 100644 --- a/src/Tizen.Messaging/Tizen.Messaging.Email/EmailRecipient.cs +++ b/src/Tizen.Messaging/Tizen.Messaging.Email/EmailRecipient.cs @@ -17,16 +17,16 @@ namespace Tizen.Messaging.Email { /// - /// The class represents recipients of an email + /// This class represents recipients of an email. /// public class EmailRecipient { /// - /// The email address of the recipient + /// The email address of the recipient. /// public string Address { get; set; } /// - /// The constructor + /// The constructor. /// public EmailRecipient() { diff --git a/src/Tizen.Messaging/Tizen.Messaging.Email/EmailSender.cs b/src/Tizen.Messaging/Tizen.Messaging.Email/EmailSender.cs index 57220ed..5c75996 100644 --- a/src/Tizen.Messaging/Tizen.Messaging.Email/EmailSender.cs +++ b/src/Tizen.Messaging/Tizen.Messaging.Email/EmailSender.cs @@ -20,15 +20,15 @@ using System.Threading.Tasks; namespace Tizen.Messaging.Email { /// - /// The class to send email messages. + /// This class is used to send email messages. /// public static class EmailSender { /// /// Sends the email message. /// - /// The email message - /// Failure if email sending failed otherwise Success + /// The email message. + /// Failure if the email sending activity failed, otherwise Success. public static async Task SendAsync(EmailMessage email) { var task = new TaskCompletionSource(); diff --git a/src/Tizen.Messaging/Tizen.Messaging.Email/NamespaceDoc.cs b/src/Tizen.Messaging/Tizen.Messaging.Email/NamespaceDoc.cs index 1c51cb5..8afebcb 100755 --- a/src/Tizen.Messaging/Tizen.Messaging.Email/NamespaceDoc.cs +++ b/src/Tizen.Messaging/Tizen.Messaging.Email/NamespaceDoc.cs @@ -16,10 +16,10 @@ /// -/// The Tizen.Messaging.Email namespace contains classes providing functionality to send emails. +/// The Tizen.Messaging.Email namespace contains classes providing the functionality to send emails. /// /// -/// The Tizen.Messaging.Email namespace contains classes providing functionality to send emails. +/// The Tizen.Messaging.Email namespace contains classes providing the functionality to send emails. /// namespace Tizen.Messaging.Email { diff --git a/src/Tizen.Messaging/Tizen.Messaging.Messages/CBMessage.cs b/src/Tizen.Messaging/Tizen.Messaging.Messages/CBMessage.cs index 949a1c8..88d1f38 100755 --- a/src/Tizen.Messaging/Tizen.Messaging.Messages/CBMessage.cs +++ b/src/Tizen.Messaging/Tizen.Messaging.Messages/CBMessage.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Messaging.Messages { /// - /// A class to represent cell broadcast messages. + /// This class represents the cell broadcast messages. /// public class CBMessage : Message { diff --git a/src/Tizen.Messaging/Tizen.Messaging.Messages/Message.cs b/src/Tizen.Messaging/Tizen.Messaging.Messages/Message.cs index e0e27f2..38f0f5e 100755 --- a/src/Tizen.Messaging/Tizen.Messaging.Messages/Message.cs +++ b/src/Tizen.Messaging/Tizen.Messaging.Messages/Message.cs @@ -21,7 +21,7 @@ using System.Collections.ObjectModel; namespace Tizen.Messaging.Messages { /// - /// A class to represent all messages. + /// This class represents all the messages. /// public abstract class Message : IDisposable { @@ -175,10 +175,10 @@ namespace Tizen.Messaging.Messages } /// - /// The message ID + /// The message ID. /// /// - /// 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. /// public int Id { @@ -196,7 +196,7 @@ namespace Tizen.Messaging.Messages } /// - /// The destination port of the message + /// The destination port of the message. /// public int Port { @@ -214,7 +214,7 @@ namespace Tizen.Messaging.Messages } /// - /// The message box type + /// The message box type. /// public MessageBoxType BoxType { @@ -241,7 +241,7 @@ namespace Tizen.Messaging.Messages } /// - /// The text of the message + /// The text of the message. /// public string Text { @@ -268,7 +268,7 @@ namespace Tizen.Messaging.Messages } /// - /// The time of the message + /// The time of the message. /// public DateTime Time { @@ -295,7 +295,7 @@ namespace Tizen.Messaging.Messages } /// - /// The SIM slot index of the message + /// The SIM slot index of the message. /// public SimSlotId SimId { @@ -322,7 +322,7 @@ namespace Tizen.Messaging.Messages } /// - /// Indicates sender of the message + /// Indicates the sender of the message. /// public IReadOnlyCollection From { diff --git a/src/Tizen.Messaging/Tizen.Messaging.Messages/MessageReceivedEventArgs.cs b/src/Tizen.Messaging/Tizen.Messaging.Messages/MessageReceivedEventArgs.cs index cd9f7ee..f98bc6f 100755 --- a/src/Tizen.Messaging/Tizen.Messaging.Messages/MessageReceivedEventArgs.cs +++ b/src/Tizen.Messaging/Tizen.Messaging.Messages/MessageReceivedEventArgs.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Messaging.Messages { /// - /// An extended EventArgs class which contains a received message. + /// An extended EventArgs class, which contains a received message. /// public class MessageReceivedEventArgs : EventArgs { @@ -31,7 +31,7 @@ namespace Tizen.Messaging.Messages } /// - /// The received message + /// The received message. /// public Message ReceivedMessage { diff --git a/src/Tizen.Messaging/Tizen.Messaging.Messages/MessagesAddress.cs b/src/Tizen.Messaging/Tizen.Messaging.Messages/MessagesAddress.cs index 19143fb..3e13494 100755 --- a/src/Tizen.Messaging/Tizen.Messaging.Messages/MessagesAddress.cs +++ b/src/Tizen.Messaging/Tizen.Messaging.Messages/MessagesAddress.cs @@ -17,20 +17,20 @@ namespace Tizen.Messaging.Messages { /// - /// A class to manage informations of message address. + /// This class is used to manage the information of the message address. /// public class MessagesAddress { internal RecipientType Type; /// - /// The address of the sender/recipient + /// The address of the sender/recipient. /// public string Number { get; } /// /// Creates a message address. /// - /// The recipient's address to receive a message + /// The recipient's address to receive a message. public MessagesAddress(string number) { Number = number; diff --git a/src/Tizen.Messaging/Tizen.Messaging.Messages/MessagesAttachment.cs b/src/Tizen.Messaging/Tizen.Messaging.Messages/MessagesAttachment.cs index 6096278..c37428e 100755 --- a/src/Tizen.Messaging/Tizen.Messaging.Messages/MessagesAttachment.cs +++ b/src/Tizen.Messaging/Tizen.Messaging.Messages/MessagesAttachment.cs @@ -17,25 +17,25 @@ namespace Tizen.Messaging.Messages { /// - /// A class to manage informations of message attachment. + /// This class is used to manage the information of the message attachment. /// public class MessagesAttachment { /// - /// The media type of attachment + /// The media type of the attachment. /// public MediaType Type { get; } /// - /// The file path of attachment + /// The file path of the attachment. /// public string FilePath { get; } /// /// Creates an attachment. /// - /// The attachment's type - /// The file path to attach + /// The attachment's type. + /// The file path to attach. public MessagesAttachment(MediaType type, string filePath) { Type = type; diff --git a/src/Tizen.Messaging/Tizen.Messaging.Messages/MessagesEnumerations.cs b/src/Tizen.Messaging/Tizen.Messaging.Messages/MessagesEnumerations.cs index dd43eb0..2fa1626 100755 --- a/src/Tizen.Messaging/Tizen.Messaging.Messages/MessagesEnumerations.cs +++ b/src/Tizen.Messaging/Tizen.Messaging.Messages/MessagesEnumerations.cs @@ -22,11 +22,11 @@ namespace Tizen.Messaging.Messages public enum SentResult { /// - /// Message sending failed + /// Message sending failed. /// Failed = -1, /// - /// Message sending succeeded + /// Message sending succeeded. /// Success = 0 } @@ -37,23 +37,23 @@ namespace Tizen.Messaging.Messages public enum MessageType { /// - /// Unknown type + /// The unknown type. /// Unknown = 0, /// - /// SMS type + /// The SMS type. /// Sms = 1, /// - /// MMS type + /// The MMS type. /// Mms = 2, /// - /// CB(Cell Broadcast) type + /// The CB(Cell Broadcast) type. /// CellBroadcast = Sms | 1 << 4, /// - /// WAP Push type + /// The WAP Push type. /// Push = Sms | 10 << 4 } @@ -64,88 +64,88 @@ namespace Tizen.Messaging.Messages public enum MessageBoxType { /// - /// All message box type + /// All message box type. /// All = 0, /// - /// Inbox type + /// The Inbox type. /// Inbox = 1, /// - /// Outbox type + /// The Outbox type. /// Outbox = 2, /// - /// Sentbox type + /// The Sentbox type. /// Sentbox = 3, /// - /// Draft type + /// The Draft type. /// Draft = 4 } /// - /// Enumeration for the SIM slot index of a message + /// Enumeration for the SIM slot index of a message. /// public enum SimSlotId { /// - /// Unknown SIM Slot + /// Unknown SIM Slot. /// Unknown = 0, /// - /// SIM Slot 1 + /// SIM Slot 1. /// Sim1 = 1, /// - /// SIM Slot 2 + /// SIM Slot 2. /// Sim2 = 2 } /// - /// Enumeration for the recipient type of a message + /// Enumeration for the recipient type of a message. /// internal enum RecipientType { /// - /// Unknown + /// Unknown. /// Unknown = 0, /// - /// 'To' recipient + /// 'To' recipient. /// To = 1, /// - /// 'Cc' (carbon copy) recipient + /// 'Cc' (carbon copy) recipient. /// Cc = 2, /// - /// 'Bcc' (blind carbon copy) recipient + /// 'Bcc' (blind carbon copy) recipient. /// Bcc = 3 } /// - /// Enumeration for the attachment tyoe for MMS messaging. + /// Enumeration for the attachment type for the MMS messaging. /// public enum MediaType { /// - /// Unknown + /// Unknown. /// Unknown = 0, /// - /// The image + /// The image. /// Image = 1, /// - /// The audio + /// The audio. /// Audio = 2, /// - /// The video + /// The video. /// Video = 3 } diff --git a/src/Tizen.Messaging/Tizen.Messaging.Messages/MessagesManager.cs b/src/Tizen.Messaging/Tizen.Messaging.Messages/MessagesManager.cs index 6b23ffa..e9571bd 100755 --- a/src/Tizen.Messaging/Tizen.Messaging.Messages/MessagesManager.cs +++ b/src/Tizen.Messaging/Tizen.Messaging.Messages/MessagesManager.cs @@ -21,7 +21,7 @@ using System.Threading.Tasks; namespace Tizen.Messaging.Messages { /// - /// 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. /// /// http://tizen.org/privilege/message.read public static class MessagesManager @@ -30,13 +30,13 @@ namespace Tizen.Messaging.Messages /// Sends a message. /// /// http://tizen.org/privilege/message.write - /// The message to be sent - /// The boolean variable to indicate sent message should be saved in sentbox or not - /// A task contains the result of message sending - /// Thrown when method failed due to invalid operation - /// Thrown when message service is not supported - /// Thrown when input coordinates are invalid - /// Thrown when application does not have proper privileges + /// The message to be sent. + /// The boolean variable used to indicate whether the sent message should be saved in the sentbox or not. + /// A task containing the result of message sending. + /// Thrown when the method failed due to an invalid operation. + /// Thrown when the message service is not supported. + /// Thrown when input coordinates are invalid. + /// Thrown when an application does not have proper privileges. public static Task SendMessageAsync(Message message, bool saveToSentbox) { return MessagesManagerImpl.Instance.SendMessageAsync(message, saveToSentbox); @@ -46,20 +46,20 @@ namespace Tizen.Messaging.Messages /// Searches for messages. /// /// http://tizen.org/privilege/message.read - /// The search filter for searching messages - /// A task contains the messages which fit with search filter - /// Thrown when method failed due to invalid operation - /// Thrown when message service is not supported - /// Thrown when input coordinates are invalid - /// Thrown when failed due to out of memory - /// Thrown when application does not have proper privileges + /// The search filter for searching messages. + /// A task containing the messages, which match the search filter. + /// Thrown when the method failed due to an invalid operation. + /// Thrown when the message service is not supported. + /// Thrown when input coordinates are invalid. + /// Thrown when failed due to out of memory. + /// Thrown when an application does not have proper privileges. public static Task> SearchMessageAsync(MessagesSearchFilter filter) { return MessagesManagerImpl.Instance.SearchMessageAsync(filter); } /// - /// (event) MessageReceived is raised when receiving a message. + /// The MessageReceived event that is raised when receiving a message. /// /// http://tizen.org/privilege/message.read static public event EventHandler MessageReceived diff --git a/src/Tizen.Messaging/Tizen.Messaging.Messages/MessagesSearchFilter.cs b/src/Tizen.Messaging/Tizen.Messaging.Messages/MessagesSearchFilter.cs index 6561463..0d8c80b 100755 --- a/src/Tizen.Messaging/Tizen.Messaging.Messages/MessagesSearchFilter.cs +++ b/src/Tizen.Messaging/Tizen.Messaging.Messages/MessagesSearchFilter.cs @@ -17,31 +17,31 @@ namespace Tizen.Messaging.Messages { /// - /// A class to represent message search filters. + /// This class represents message search filters. /// public class MessagesSearchFilter { /// - /// Create a search filter for searching messages. + /// Creates a search filter for searching messages. /// public MessagesSearchFilter() { } /// - /// The message box type + /// The message box type. /// public MessageBoxType MessageBoxType { get; set; } /// - /// The message type + /// The message type. /// public MessageType MessageType { get; set; } /// - /// The keyword to search in the text and subject + /// The keyword to search in the text and the subject. /// public string TextKeyword { get; set; } /// - /// The recipient address + /// The recipient address. /// public string AddressKeyword { get; set; } } diff --git a/src/Tizen.Messaging/Tizen.Messaging.Messages/MmsMessage.cs b/src/Tizen.Messaging/Tizen.Messaging.Messages/MmsMessage.cs index f73310a..88a01ca 100755 --- a/src/Tizen.Messaging/Tizen.Messaging.Messages/MmsMessage.cs +++ b/src/Tizen.Messaging/Tizen.Messaging.Messages/MmsMessage.cs @@ -20,7 +20,7 @@ using System.Collections.Generic; namespace Tizen.Messaging.Messages { /// - /// A class to represent multimedia messages. + /// This class represents multimedia messages. /// public class MmsMessage : Message { @@ -39,7 +39,7 @@ namespace Tizen.Messaging.Messages } /// - /// The subject of the multimedia message + /// The subject of the multimedia message. /// public string Subject { @@ -66,7 +66,7 @@ namespace Tizen.Messaging.Messages } /// - /// Collection of normal message recipients + /// The collection of normal message recipients. /// public ICollection To { @@ -77,7 +77,7 @@ namespace Tizen.Messaging.Messages } /// - /// Collection of CC(carbon copy) message recipients + /// The collection of CC (carbon copy) message recipients. /// public ICollection Cc { @@ -88,7 +88,7 @@ namespace Tizen.Messaging.Messages } /// - /// Collection of BCC(blind carbon copy) message recipients + /// The collection of BCC (blind carbon copy) message recipients. /// public ICollection Bcc { @@ -99,7 +99,7 @@ namespace Tizen.Messaging.Messages } /// - /// The list of attachment files + /// The list of attachment files. /// public IList Attachments { diff --git a/src/Tizen.Messaging/Tizen.Messaging.Messages/NamespaceDoc.cs b/src/Tizen.Messaging/Tizen.Messaging.Messages/NamespaceDoc.cs index 45d5a8e..79377ed 100755 --- a/src/Tizen.Messaging/Tizen.Messaging.Messages/NamespaceDoc.cs +++ b/src/Tizen.Messaging/Tizen.Messaging.Messages/NamespaceDoc.cs @@ -15,10 +15,10 @@ */ /// -/// The Tizen.Messaging.Messages namespace contains classes providing functionality to send, receive and search for messages. +/// The Tizen.Messaging.Messages namespace contains classes providing the functionality to send, receive, and search messages. /// /// -/// The Tizen.Messaging.Messages namespace contains classes providing functionality to send, receive and search for messages. +/// The Tizen.Messaging.Messages namespace contains classes providing the functionality to send, receive, and search messages. /// namespace Tizen.Messaging.Messages { diff --git a/src/Tizen.Messaging/Tizen.Messaging.Messages/PushMessage.cs b/src/Tizen.Messaging/Tizen.Messaging.Messages/PushMessage.cs index 667e7ff..d14f3c1 100755 --- a/src/Tizen.Messaging/Tizen.Messaging.Messages/PushMessage.cs +++ b/src/Tizen.Messaging/Tizen.Messaging.Messages/PushMessage.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.Messaging.Messages { /// - /// A class to represent WAP push messages. + /// This class represents the WAP push messages. /// public class PushMessage : Message { diff --git a/src/Tizen.Messaging/Tizen.Messaging.Messages/SmsMessage.cs b/src/Tizen.Messaging/Tizen.Messaging.Messages/SmsMessage.cs index 62ffd1e..456962c 100755 --- a/src/Tizen.Messaging/Tizen.Messaging.Messages/SmsMessage.cs +++ b/src/Tizen.Messaging/Tizen.Messaging.Messages/SmsMessage.cs @@ -20,7 +20,7 @@ using System.Collections.Generic; namespace Tizen.Messaging.Messages { /// - /// A class to represent short text messages. + /// This class represents short text messages. /// public class SmsMessage : Message { @@ -36,7 +36,7 @@ namespace Tizen.Messaging.Messages } /// - /// Collection of normal message recipients + /// The collection of normal message recipients. /// public ICollection To { -- 2.7.4