/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this file,
 * You can obtain one at http://mozilla.org/MPL/2.0/. */

#include "nsIDOMEvent.idl"

[scriptable, builtinclass, uuid(905348f1-3d06-443c-8762-567e7e4b6696)]
interface nsIDOMCFStateChangeEvent : nsIDOMEvent
{
  /**
   * Indicates about errors while setting up the Call forwarding rule.
   */
  readonly attribute boolean success;

  /**
   * Indicates what to do with the rule.
   *
   * One of the CALL_FORWARD_ACTION_* constants. It will be either disable (0),
   * enable (1), query status (2), registration (3), or erasure (4).
   *
   * @see 3GPP nsIDOMMozMobileCFInfo.CALL_FORWARD_ACTION_* values.
   * @see 3GPP TS 27.007 7.11 "mode".
   */
  readonly attribute unsigned short action;

  /**
   * Indicates the reason the call is being forwarded.
   *
   * One of the CALL_FORWARD_REASON_* constants. It will be either
   * unconditional (0), mobile busy (1), no reply (2), not reachable (3),
   * all call forwarding (4), or all conditional call forwarding (5).
   *
   * @see 3GPP nsIDOMMozMobileCFInfo.CALL_FORWARD_REASON_* values.
   * @see 3GPP TS 27.007 7.11 "reason".
   */
  readonly attribute unsigned short reason;

  /**
   * Phone number of forwarding address.
   */
  readonly attribute DOMString number;

  /**
   * When "no reply" is enabled or queried, this gives the time in
   * seconds to wait before call is forwarded.
   */
  readonly attribute unsigned short timeSeconds;

  /**
   * Service for which the call forward is set up. It should be one of the
   * nsIDOMMozMobileConnectionInfo.ICC_SERVICE_CLASS_* values.
   */
  readonly attribute unsigned short serviceClass;

  [noscript] void initCFStateChangeEvent(in DOMString aType,
                                         in boolean aCanBubble,
                                         in boolean aCancelable,
                                         in boolean aSuccess,
                                         in unsigned short aAction,
                                         in unsigned short aReason,
                                         in DOMString aNumber,
                                         in unsigned short aTimeSeconds,
                                         in unsigned short aServiceClass);
};

dictionary CFStateChangeEventInit : EventInit
{
  boolean success;
  unsigned short action;
  unsigned short reason;
  DOMString number;
  unsigned short timeSeconds;
  unsigned short serviceClass;
};
