dom/nfc/nsINfcContentHelper.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
   3  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   4
   5 #include "nsISupports.idl"
   6 #include "nsIDOMDOMRequest.idl"
   7
   8 interface nsIVariant;
   9
  10 [scriptable, uuid(57fc2998-1058-4fd5-8dd9-0e303218d5fd)]
  11 interface nsINfcPeerEventListener : nsISupports
  12 {
  13   /**
  14    * Callback function used to notify peerready.
  15    *
  16    * @param sessionToken
  17    *        SessionToken received from Chrome process
  18    */
  19    void notifyPeerReady(in DOMString sessionToken);
  20
  21   /**
  22    * Callback function used to notify peerlost.
  23    *
  24    * @param sessionToken
  25    *        SessionToken received from Chrome process
  26    */
  27    void notifyPeerLost(in DOMString sessionToken);
  28 };
  29
  30 [scriptable, uuid(9a41d969-3375-4933-814e-2da781c8f691)]
  31 interface nsINfcContentHelper : nsISupports
  32 {
  33   const long NFC_EVENT_PEER_READY = 0x01;
  34   const long NFC_EVENT_PEER_LOST  = 0x02;
  35
  36   boolean checkSessionToken(in DOMString sessionToken);
  37
  38   nsIDOMDOMRequest getDetailsNDEF(in nsIDOMWindow window, in DOMString sessionToken);
  39   nsIDOMDOMRequest readNDEF(in nsIDOMWindow window, in DOMString sessionToken);
  40   nsIDOMDOMRequest writeNDEF(in nsIDOMWindow window, in nsIVariant records, in DOMString sessionToken);
  41   nsIDOMDOMRequest makeReadOnlyNDEF(in nsIDOMWindow window, in DOMString sessionToken);
  42
  43   nsIDOMDOMRequest connect(in nsIDOMWindow window, in unsigned long techType, in DOMString sessionToken);
  44   nsIDOMDOMRequest close(in nsIDOMWindow window, in DOMString sessionToken);
  45
  46  /**
  47   * Initiate Send file operation
  48   *
  49   * @param window
  50   *        Current window
  51   *
  52   * @param blob
  53   *        Raw data of the file to be sent. This object represents a file-like
  54   *        (nsIDOMFile) object of immutable, raw data. The blob data needs
  55   *        to be 'object wrapped' before calling this interface.
  56   *
  57   * @param sessionToken
  58   *        Current token
  59   *
  60   * Returns DOMRequest, if initiation of send file operation is successful
  61   * then 'onsuccess' is called else 'onerror'
  62   */
  63   nsIDOMDOMRequest sendFile(in nsIDOMWindow window,
  64                             in jsval blob,
  65                             in DOMString sessionToken);
  66
  67   /**
  68    * Register the peer event listener.
  69    *
  70    * @param listener  An instance of the nsINfcPeerEventListener.
  71    */
  72   void registerPeerEventListener(in nsINfcPeerEventListener listener);
  73
  74  /**
  75   * Register the given application id with Chrome process
  76   *
  77   * @param window
  78   *        Current window
  79   *
  80   * @param appId
  81   *        Application ID to be registered
  82   */
  83   void registerTargetForPeerReady(in nsIDOMWindow window,
  84                                   in unsigned long appId);
  85
  86  /**
  87   * Unregister the given application id with Chrome process
  88   *
  89   * @param window
  90   *        Current window
  91   *
  92   * @param appId
  93   *        Application ID to be registered
  94   */
  95   void unregisterTargetForPeerReady(in nsIDOMWindow window,
  96                                     in unsigned long appId);
  97
  98  /**
  99   * Checks if the given application's id is a registered peer target (with the Chrome process)
 100   *
 101   * @param window
 102   *        Current window
 103   *
 104   * @param appId
 105   *        Application ID to be updated with Chrome process
 106   *
 107   * Returns DOMRequest, if appId is registered then 'onsuccess' is called else 'onerror'
 108   */
 109   nsIDOMDOMRequest checkP2PRegistration(in nsIDOMWindow window, in unsigned long appId);
 110
 111  /**
 112   * Notify the Chrome process that user has accepted to share nfc message on P2P UI
 113   *
 114   * @param window
 115   *        Current window
 116   *
 117   * @param appId
 118   *        Application ID that is capable of handling NFC_EVENT_PEER_READY event
 119   */
 120   void notifyUserAcceptedP2P(in nsIDOMWindow window, in unsigned long appId);
 121
 122  /**
 123   * Notify the status of sendFile operation to Chrome process
 124   *
 125   * @param window
 126   *        Current window
 127   *
 128   * @param status
 129   *        Status of sendFile operation
 130   *
 131   * @param requestId
 132   *        Request ID of SendFile DOM Request
 133   */
 134   void notifySendFileStatus(in nsIDOMWindow window,
 135                             in octet status,
 136                             in DOMString requestId);
 137
 138   /**
 139    * Power on the NFC hardware and start polling for NFC tags or devices.
 140    */
 141   nsIDOMDOMRequest startPoll(in nsIDOMWindow window);
 142
 143   /**
 144    * Stop polling for NFC tags or devices. i.e. enter low power mode.
 145    */
 146   nsIDOMDOMRequest stopPoll(in nsIDOMWindow window);
 147
 148   /**
 149    * Power off the NFC hardware.
 150    */
 151   nsIDOMDOMRequest powerOff(in nsIDOMWindow window);
 152 };