dom/mobilemessage/interfaces/nsIDOMMozMmsMessage.idl

   1 /* This Source Code Form is subject to the terms of the Mozilla Public
   2  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
   3  * You can obtain one at http://mozilla.org/MPL/2.0/. */
   4
   5 #include "domstubs.idl"
   6 #include "nsISupports.idl"
   7
   8 interface nsIDOMBlob;
   9
  10 // If this is changed, change the WebIDL dictionary as well.
  11 dictionary MmsAttachment
  12 {
  13   DOMString? id;
  14   DOMString? location;
  15   nsIDOMBlob content; // If the content blob is a text/plain type, the encoding
  16                       // for text should always be "utf-8".
  17 };
  18
  19 dictionary MmsDeliveryInfo
  20 {
  21   DOMString? receiver;
  22   DOMString? deliveryStatus;
  23   DOMTimeStamp deliveryTimestamp; // 0 if not available (e.g.,
  24                                   // |delivery| = "received" or not yet delivered).
  25   DOMString? readStatus;
  26   DOMTimeStamp readTimestamp; // 0 if not available (e.g.,
  27                               // |delivery| = "received" or not yet read).
  28 };
  29
  30 [scriptable, builtinclass, uuid(f41d7400-0026-11e3-829d-eb7459c03810)]
  31 interface nsIDOMMozMmsMessage : nsISupports
  32 {
  33   /**
  34    * |type| is always "mms".
  35    */
  36   readonly attribute DOMString type;
  37
  38   readonly attribute long      id;
  39
  40   readonly attribute unsigned long long threadId;
  41
  42   /**
  43    * Integrated Circuit Card Identifier.
  44    *
  45    * Will be null if ICC is not available.
  46    */
  47   readonly attribute DOMString iccId;
  48
  49   /**
  50    * Should be "not-downloaded", "received", "sending", "sent" or "error".
  51    */
  52   readonly attribute DOMString delivery;
  53
  54   [implicit_jscontext]
  55   readonly attribute jsval     deliveryInfo;   // MmsDeliveryInfo[]
  56
  57   readonly attribute DOMString sender;
  58
  59   [implicit_jscontext]
  60   readonly attribute jsval     receivers;      // DOMString[]
  61
  62   readonly attribute DOMTimeStamp timestamp;
  63
  64   readonly attribute DOMTimeStamp sentTimestamp;
  65                                   // 0 if not available (e.g., |delivery| =
  66                                   // "sending").
  67
  68   readonly attribute boolean   read;
  69   readonly attribute DOMString subject;
  70   readonly attribute DOMString smil;
  71
  72   [implicit_jscontext]
  73   readonly attribute jsval     attachments;    // MmsAttachment[]
  74
  75   readonly attribute DOMTimeStamp expiryDate;  // Expiry date for an MMS to be
  76                                                // manually downloaded.
  77
  78   // Request read report from sender or not.
  79   readonly attribute boolean   readReportRequested;
  80 };