Artifacts/bin/public/Tizen.Messaging.xml

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