Artifacts/bin/public/Tizen.Messaging.xml

   1 <?xml version="1.0"?>\r
   2 <doc>\r
   3     <assembly>\r
   4         <name>Tizen.Messaging</name>\r
   5     </assembly>\r
   6     <members>\r
   7         <member name="T:Tizen.Messaging.Email.EmailAttachment">\r
   8             <summary>\r
   9             Represents an email attachment.\r
  10             </summary>\r
  11         </member>\r
  12         <member name="P:Tizen.Messaging.Email.EmailAttachment.FilePath">\r
  13             <summary>\r
  14             The absolute full path of the file to be attached.\r
  15             </summary>\r
  16         </member>\r
  17         <member name="M:Tizen.Messaging.Email.EmailAttachment.#ctor">\r
  18             <summary>\r
  19             The constructor.\r
  20             </summary>\r
  21         </member>\r
  22         <member name="T:Tizen.Messaging.Email.EmailSendResult">\r
  23             <summary>\r
  24             Result of sending the email.\r
  25             </summary>\r
  26         </member>\r
  27         <member name="F:Tizen.Messaging.Email.EmailSendResult.Failure">\r
  28             <summary>\r
  29             Failed to send the message.\r
  30             </summary>\r
  31         </member>\r
  32         <member name="F:Tizen.Messaging.Email.EmailSendResult.Success">\r
  33             <summary>\r
  34             Email sent successfully.\r
  35             </summary>\r
  36         </member>\r
  37         <member name="T:Tizen.Messaging.Email.EmailMessage">\r
  38             <summary>\r
  39             This class contains the Messaging API to support sending email messages.\r
  40             </summary>\r
  41         </member>\r
  42         <member name="M:Tizen.Messaging.Email.EmailMessage.#ctor">\r
  43             <summary>\r
  44             The constructor.\r
  45             </summary>\r
  46         </member>\r
  47         <member name="P:Tizen.Messaging.Email.EmailMessage.Subject">\r
  48             <summary>\r
  49             The subject of the email message.\r
  50             </summary>\r
  51         </member>\r
  52         <member name="P:Tizen.Messaging.Email.EmailMessage.Body">\r
  53             <summary>\r
  54             The body of the email message.\r
  55             </summary>\r
  56         </member>\r
  57         <member name="P:Tizen.Messaging.Email.EmailMessage.Attachments">\r
  58             <summary>\r
  59             The list of file attachments.\r
  60             </summary>\r
  61         </member>\r
  62         <member name="P:Tizen.Messaging.Email.EmailMessage.To">\r
  63             <summary>\r
  64             The collection of normal email recipients.\r
  65             </summary>\r
  66             <remarks>\r
  67             The email address should be in the standard format (as described in the Internet standards RFC 5321 and RFC 5322).\r
  68             </remarks>\r
  69         </member>\r
  70         <member name="P:Tizen.Messaging.Email.EmailMessage.Cc">\r
  71             <summary>\r
  72             The collection of CC (carbon copy) email recipients.\r
  73             </summary>\r
  74             <remarks>\r
  75             The email address should be in the standard format (as described in the Internet standards RFC 5321 and RFC 5322).\r
  76             </remarks>\r
  77         </member>\r
  78         <member name="P:Tizen.Messaging.Email.EmailMessage.Bcc">\r
  79             <summary>\r
  80             The collection of BCC (blind carbon copy) email recipients.\r
  81             </summary>\r
  82             <remarks>\r
  83             The email address should be in the standard format (as described in the Internet standards RFC 5321 and RFC 5322).\r
  84             </remarks>\r
  85         </member>\r
  86         <member name="T:Tizen.Messaging.Email.EmailRecipient">\r
  87             <summary>\r
  88             This class represents recipients of an email.\r
  89             </summary>\r
  90         </member>\r
  91         <member name="P:Tizen.Messaging.Email.EmailRecipient.Address">\r
  92             <summary>\r
  93             The email address of the recipient.\r
  94             </summary>\r
  95         </member>\r
  96         <member name="M:Tizen.Messaging.Email.EmailRecipient.#ctor">\r
  97             <summary>\r
  98             The constructor.\r
  99             </summary>\r
 100         </member>\r
 101         <member name="T:Tizen.Messaging.Email.EmailSender">\r
 102             <summary>\r
 103             This class is used to send email messages.\r
 104             </summary>\r
 105         </member>\r
 106         <member name="M:Tizen.Messaging.Email.EmailSender.SendAsync(Tizen.Messaging.Email.EmailMessage)">\r
 107             <summary>\r
 108             Sends the email message.\r
 109             </summary>\r
 110             <param name="email">The email message.</param>\r
 111             <returns> Failure if the email sending activity failed, otherwise Success.</returns>\r
 112         </member>\r
 113         <member name="T:Tizen.Messaging.Messages.CBMessage">\r
 114             <summary>\r
 115             This class represents the cell broadcast messages.\r
 116             </summary>\r
 117         </member>\r
 118         <member name="T:Tizen.Messaging.Messages.Message">\r
 119             <summary>\r
 120             This class represents all the messages.\r
 121             </summary>\r
 122         </member>\r
 123         <member name="P:Tizen.Messaging.Messages.Message.Id">\r
 124             <summary>\r
 125             The message ID.\r
 126             </summary>\r
 127             <remarks>\r
 128             After creating the Message object, the default value of this property is 0. After sending, this value is changed.\r
 129             </remarks>\r
 130         </member>\r
 131         <member name="P:Tizen.Messaging.Messages.Message.Port">\r
 132             <summary>\r
 133             The destination port of the message.\r
 134             </summary>\r
 135         </member>\r
 136         <member name="P:Tizen.Messaging.Messages.Message.BoxType">\r
 137             <summary>\r
 138             The message box type.\r
 139             </summary>\r
 140         </member>\r
 141         <member name="P:Tizen.Messaging.Messages.Message.Text">\r
 142             <summary>\r
 143             The text of the message.\r
 144             </summary>\r
 145         </member>\r
 146         <member name="P:Tizen.Messaging.Messages.Message.Time">\r
 147             <summary>\r
 148             The time of the message.\r
 149             </summary>\r
 150         </member>\r
 151         <member name="P:Tizen.Messaging.Messages.Message.SimId">\r
 152             <summary>\r
 153             The SIM slot index of the message.\r
 154             </summary>\r
 155         </member>\r
 156         <member name="P:Tizen.Messaging.Messages.Message.From">\r
 157             <summary>\r
 158             Indicates the sender of the message.\r
 159             </summary>\r
 160         </member>\r
 161         <member name="T:Tizen.Messaging.Messages.MessageReceivedEventArgs">\r
 162             <summary>\r
 163             An extended EventArgs class, which contains a received message.\r
 164             </summary>\r
 165         </member>\r
 166         <member name="P:Tizen.Messaging.Messages.MessageReceivedEventArgs.ReceivedMessage">\r
 167             <summary>\r
 168             The received message.\r
 169             </summary>\r
 170         </member>\r
 171         <member name="T:Tizen.Messaging.Messages.MessagesAddress">\r
 172             <summary>\r
 173             This class is used to manage the information of the message address.\r
 174             </summary>\r
 175         </member>\r
 176         <member name="P:Tizen.Messaging.Messages.MessagesAddress.Number">\r
 177             <summary>\r
 178             The address of the sender/recipient.\r
 179             </summary>\r
 180         </member>\r
 181         <member name="M:Tizen.Messaging.Messages.MessagesAddress.#ctor(System.String)">\r
 182             <summary>\r
 183             Creates a message address.\r
 184             </summary>\r
 185             <param name="number">The recipient's address to receive a message.</param>\r
 186         </member>\r
 187         <member name="T:Tizen.Messaging.Messages.MessagesAttachment">\r
 188             <summary>\r
 189             This class is used to manage the information of the message attachment.\r
 190             </summary>\r
 191         </member>\r
 192         <member name="P:Tizen.Messaging.Messages.MessagesAttachment.Type">\r
 193             <summary>\r
 194             The media type of the attachment.\r
 195             </summary>\r
 196         </member>\r
 197         <member name="P:Tizen.Messaging.Messages.MessagesAttachment.FilePath">\r
 198             <summary>\r
 199             The file path of the attachment.\r
 200             </summary>\r
 201         </member>\r
 202         <member name="M:Tizen.Messaging.Messages.MessagesAttachment.#ctor(Tizen.Messaging.Messages.MediaType,System.String)">\r
 203             <summary>\r
 204             Creates an attachment.\r
 205             </summary>\r
 206             <param name="type">The attachment's type.</param>\r
 207             <param name="filePath">The file path to attach.</param>\r
 208         </member>\r
 209         <member name="T:Tizen.Messaging.Messages.SentResult">\r
 210             <summary>\r
 211             Enumeration for the result of sending a message.\r
 212             </summary>\r
 213         </member>\r
 214         <member name="F:Tizen.Messaging.Messages.SentResult.Failed">\r
 215             <summary>\r
 216             Message sending failed.\r
 217             </summary>\r
 218         </member>\r
 219         <member name="F:Tizen.Messaging.Messages.SentResult.Success">\r
 220             <summary>\r
 221             Message sending succeeded.\r
 222             </summary>\r
 223         </member>\r
 224         <member name="T:Tizen.Messaging.Messages.MessageType">\r
 225             <summary>\r
 226             Enumeration for the message type.\r
 227             </summary>\r
 228         </member>\r
 229         <member name="F:Tizen.Messaging.Messages.MessageType.Unknown">\r
 230             <summary>\r
 231             The unknown type.\r
 232             </summary>\r
 233         </member>\r
 234         <member name="F:Tizen.Messaging.Messages.MessageType.Sms">\r
 235             <summary>\r
 236             The SMS type.\r
 237             </summary>\r
 238         </member>\r
 239         <member name="F:Tizen.Messaging.Messages.MessageType.Mms">\r
 240             <summary>\r
 241             The MMS type.\r
 242             </summary>\r
 243         </member>\r
 244         <member name="F:Tizen.Messaging.Messages.MessageType.CellBroadcast">\r
 245             <summary>\r
 246             The CB(Cell Broadcast) type.\r
 247             </summary>\r
 248         </member>\r
 249         <member name="F:Tizen.Messaging.Messages.MessageType.Push">\r
 250             <summary>\r
 251             The WAP Push type.\r
 252             </summary>\r
 253         </member>\r
 254         <member name="T:Tizen.Messaging.Messages.MessageBoxType">\r
 255             <summary>\r
 256             Enumeration for the message box type.\r
 257             </summary>\r
 258         </member>\r
 259         <member name="F:Tizen.Messaging.Messages.MessageBoxType.All">\r
 260             <summary>\r
 261             All message box type.\r
 262             </summary>\r
 263         </member>\r
 264         <member name="F:Tizen.Messaging.Messages.MessageBoxType.Inbox">\r
 265             <summary>\r
 266             The Inbox type.\r
 267             </summary>\r
 268         </member>\r
 269         <member name="F:Tizen.Messaging.Messages.MessageBoxType.Outbox">\r
 270             <summary>\r
 271             The Outbox type.\r
 272             </summary>\r
 273         </member>\r
 274         <member name="F:Tizen.Messaging.Messages.MessageBoxType.Sentbox">\r
 275             <summary>\r
 276             The Sentbox type.\r
 277             </summary>\r
 278         </member>\r
 279         <member name="F:Tizen.Messaging.Messages.MessageBoxType.Draft">\r
 280             <summary>\r
 281             The Draft type.\r
 282             </summary>\r
 283         </member>\r
 284         <member name="T:Tizen.Messaging.Messages.SimSlotId">\r
 285             <summary>\r
 286             Enumeration for the SIM slot index of a message.\r
 287             </summary>\r
 288         </member>\r
 289         <member name="F:Tizen.Messaging.Messages.SimSlotId.Unknown">\r
 290             <summary>\r
 291             Unknown SIM Slot.\r
 292             </summary>\r
 293         </member>\r
 294         <member name="F:Tizen.Messaging.Messages.SimSlotId.Sim1">\r
 295             <summary>\r
 296             SIM Slot 1.\r
 297             </summary>\r
 298         </member>\r
 299         <member name="F:Tizen.Messaging.Messages.SimSlotId.Sim2">\r
 300             <summary>\r
 301             SIM Slot 2.\r
 302             </summary>\r
 303         </member>\r
 304         <member name="T:Tizen.Messaging.Messages.RecipientType">\r
 305             <summary>\r
 306             Enumeration for the recipient type of a message.\r
 307             </summary>\r
 308         </member>\r
 309         <member name="F:Tizen.Messaging.Messages.RecipientType.Unknown">\r
 310             <summary>\r
 311             Unknown.\r
 312             </summary>\r
 313         </member>\r
 314         <member name="F:Tizen.Messaging.Messages.RecipientType.To">\r
 315             <summary>\r
 316             'To' recipient.\r
 317             </summary>\r
 318         </member>\r
 319         <member name="F:Tizen.Messaging.Messages.RecipientType.Cc">\r
 320             <summary>\r
 321             'Cc' (carbon copy) recipient.\r
 322             </summary>\r
 323         </member>\r
 324         <member name="F:Tizen.Messaging.Messages.RecipientType.Bcc">\r
 325             <summary>\r
 326             'Bcc' (blind carbon copy) recipient.\r
 327             </summary>\r
 328         </member>\r
 329         <member name="T:Tizen.Messaging.Messages.MediaType">\r
 330             <summary>\r
 331             Enumeration for the attachment type for the MMS messaging.\r
 332             </summary>\r
 333         </member>\r
 334         <member name="F:Tizen.Messaging.Messages.MediaType.Unknown">\r
 335             <summary>\r
 336             Unknown.\r
 337             </summary>\r
 338         </member>\r
 339         <member name="F:Tizen.Messaging.Messages.MediaType.Image">\r
 340             <summary>\r
 341             The image.\r
 342             </summary>\r
 343         </member>\r
 344         <member name="F:Tizen.Messaging.Messages.MediaType.Audio">\r
 345             <summary>\r
 346             The audio.\r
 347             </summary>\r
 348         </member>\r
 349         <member name="F:Tizen.Messaging.Messages.MediaType.Video">\r
 350             <summary>\r
 351             The video.\r
 352             </summary>\r
 353         </member>\r
 354         <member name="T:Tizen.Messaging.Messages.MessagesManager">\r
 355             <summary>\r
 356             This class is used for the message management. It allows applications to use the message service.\r
 357             </summary>\r
 358             <privilege>http://tizen.org/privilege/message.read</privilege>\r
 359         </member>\r
 360         <member name="M:Tizen.Messaging.Messages.MessagesManager.SendMessageAsync(Tizen.Messaging.Messages.Message,System.Boolean)">\r
 361             <summary>\r
 362             Sends a message.\r
 363             </summary>\r
 364             <privilege>http://tizen.org/privilege/message.write</privilege>\r
 365             <param name="message">The message to be sent.</param>\r
 366             <param name="saveToSentbox">The boolean variable used to indicate whether the sent message should be saved in the sentbox or not.</param>\r
 367             <returns>A task containing the result of message sending.</returns>\r
 368             <exception cref="T:System.InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>\r
 369             <exception cref="T:System.NotSupportedException">Thrown when the message service is not supported.</exception>\r
 370             <exception cref="T:System.ArgumentException">Thrown when input coordinates are invalid.</exception>\r
 371             <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have proper privileges.</exception>\r
 372         </member>\r
 373         <member name="M:Tizen.Messaging.Messages.MessagesManager.SearchMessageAsync(Tizen.Messaging.Messages.MessagesSearchFilter)">\r
 374             <summary>\r
 375             Searches for messages.\r
 376             </summary>\r
 377             <privilege>http://tizen.org/privilege/message.read</privilege>\r
 378             <param name="filter">The search filter for searching messages.</param>\r
 379             <returns>A task containing the messages, which match the search filter.</returns>\r
 380             <exception cref="T:System.InvalidOperationException">Thrown when the method failed due to an invalid operation.</exception>\r
 381             <exception cref="T:System.NotSupportedException">Thrown when the message service is not supported.</exception>\r
 382             <exception cref="T:System.ArgumentException">Thrown when input coordinates are invalid.</exception>\r
 383             <exception cref="T:System.OutOfMemoryException">Thrown when failed due to out of memory.</exception>\r
 384             <exception cref="T:System.UnauthorizedAccessException">Thrown when an application does not have proper privileges.</exception>\r
 385         </member>\r
 386         <member name="E:Tizen.Messaging.Messages.MessagesManager.MessageReceived">\r
 387             <summary>\r
 388             The MessageReceived event that is raised when receiving a message.\r
 389             </summary>\r
 390             <privilege>http://tizen.org/privilege/message.read</privilege>\r
 391         </member>\r
 392         <member name="T:Tizen.Messaging.Messages.MessagesSearchFilter">\r
 393             <summary>\r
 394             This class represents message search filters.\r
 395             </summary>\r
 396         </member>\r
 397         <member name="M:Tizen.Messaging.Messages.MessagesSearchFilter.#ctor">\r
 398             <summary>\r
 399             Creates a search filter for searching messages.\r
 400             </summary>\r
 401         </member>\r
 402         <member name="P:Tizen.Messaging.Messages.MessagesSearchFilter.MessageBoxType">\r
 403             <summary>\r
 404             The message box type.\r
 405             </summary>\r
 406         </member>\r
 407         <member name="P:Tizen.Messaging.Messages.MessagesSearchFilter.MessageType">\r
 408             <summary>\r
 409             The message type.\r
 410             </summary>\r
 411         </member>\r
 412         <member name="P:Tizen.Messaging.Messages.MessagesSearchFilter.TextKeyword">\r
 413             <summary>\r
 414             The keyword to search in the text and the subject.\r
 415             </summary>\r
 416         </member>\r
 417         <member name="P:Tizen.Messaging.Messages.MessagesSearchFilter.AddressKeyword">\r
 418             <summary>\r
 419             The recipient address.\r
 420             </summary>\r
 421         </member>\r
 422         <member name="T:Tizen.Messaging.Messages.MmsMessage">\r
 423             <summary>\r
 424             This class represents multimedia messages.\r
 425             </summary>\r
 426         </member>\r
 427         <member name="M:Tizen.Messaging.Messages.MmsMessage.#ctor">\r
 428             <summary>\r
 429             Creates a multimedia message.\r
 430             </summary>\r
 431         </member>\r
 432         <member name="P:Tizen.Messaging.Messages.MmsMessage.Subject">\r
 433             <summary>\r
 434             The subject of the multimedia message.\r
 435             </summary>\r
 436         </member>\r
 437         <member name="P:Tizen.Messaging.Messages.MmsMessage.To">\r
 438             <summary>\r
 439             The collection of normal message recipients.\r
 440             </summary>\r
 441         </member>\r
 442         <member name="P:Tizen.Messaging.Messages.MmsMessage.Cc">\r
 443             <summary>\r
 444             The collection of CC (carbon copy) message recipients.\r
 445             </summary>\r
 446         </member>\r
 447         <member name="P:Tizen.Messaging.Messages.MmsMessage.Bcc">\r
 448             <summary>\r
 449             The collection of BCC (blind carbon copy) message recipients.\r
 450             </summary>\r
 451         </member>\r
 452         <member name="P:Tizen.Messaging.Messages.MmsMessage.Attachments">\r
 453             <summary>\r
 454             The list of attachment files.\r
 455             </summary>\r
 456         </member>\r
 457         <member name="T:Tizen.Messaging.Messages.PushMessage">\r
 458             <summary>\r
 459             This class represents the WAP push messages.\r
 460             </summary>\r
 461         </member>\r
 462         <member name="T:Tizen.Messaging.Messages.SmsMessage">\r
 463             <summary>\r
 464             This class represents short text messages.\r
 465             </summary>\r
 466         </member>\r
 467         <member name="M:Tizen.Messaging.Messages.SmsMessage.#ctor">\r
 468             <summary>\r
 469             Creates a short text message.\r
 470             </summary>\r
 471         </member>\r
 472         <member name="P:Tizen.Messaging.Messages.SmsMessage.To">\r
 473             <summary>\r
 474             The collection of normal message recipients.\r
 475             </summary>\r
 476         </member>\r
 477     </members>\r
 478 </doc>\r