@topoos/push/dist/org.wso2.client.model.PUSH/SendNotificationOptions.js

SDK para el servicio de envío de notificaciones mediante Firebase Cloud Messaging, desarrollado en NodeJS.

"use strict";

Object.defineProperty(exports, "__esModule", {
  value: true
});
exports["default"] = void 0;

var _ApiClient = _interopRequireDefault(require("../ApiClient"));

function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }

function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }

function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }

function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }

/**
 * The SendNotificationOptions model module.
 * @module org.wso2.client.model.PUSH/SendNotificationOptions
 * @version 1.0.0
 */
var SendNotificationOptions = /*#__PURE__*/function () {
  /**
   * Constructs a new <code>SendNotificationOptions</code>.
   * Objeto que recoge las opciones de envío de la notificación
   * @alias module:org.wso2.client.model.PUSH/SendNotificationOptions
   */
  function SendNotificationOptions() {
    _classCallCheck(this, SendNotificationOptions);

    SendNotificationOptions.initialize(this);
  }
  /**
   * Initializes the fields of this object.
   * This method is used by the constructors of any subclasses, in order to implement multiple inheritance (mix-ins).
   * Only for internal use.
   */


  _createClass(SendNotificationOptions, null, [{
    key: "initialize",
    value: function initialize(obj) {}
    /**
     * Constructs a <code>SendNotificationOptions</code> from a plain JavaScript object, optionally creating a new instance.
     * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
     * @param {Object} data The plain JavaScript object bearing properties of interest.
     * @param {module:org.wso2.client.model.PUSH/SendNotificationOptions} obj Optional instance to populate.
     * @return {module:org.wso2.client.model.PUSH/SendNotificationOptions} The populated <code>SendNotificationOptions</code> instance.
     */

  }, {
    key: "constructFromObject",
    value: function constructFromObject(data, obj) {
      if (data) {
        obj = obj || new SendNotificationOptions();

        if (data.hasOwnProperty('collapseKey')) {
          obj['collapseKey'] = _ApiClient["default"].convertToType(data['collapseKey'], 'String');
        }

        if (data.hasOwnProperty('priority')) {
          obj['priority'] = _ApiClient["default"].convertToType(data['priority'], 'String');
        }

        if (data.hasOwnProperty('contentAvailable')) {
          obj['contentAvailable'] = _ApiClient["default"].convertToType(data['contentAvailable'], 'Boolean');
        }

        if (data.hasOwnProperty('mutableContent')) {
          obj['mutableContent'] = _ApiClient["default"].convertToType(data['mutableContent'], 'Boolean');
        }

        if (data.hasOwnProperty('timeToLive')) {
          obj['timeToLive'] = _ApiClient["default"].convertToType(data['timeToLive'], 'Number');
        }

        if (data.hasOwnProperty('restrictedPackageName')) {
          obj['restrictedPackageName'] = _ApiClient["default"].convertToType(data['restrictedPackageName'], 'String');
        }

        if (data.hasOwnProperty('dryRun')) {
          obj['dryRun'] = _ApiClient["default"].convertToType(data['dryRun'], 'Boolean');
        }
      }

      return obj;
    }
  }]);

  return SendNotificationOptions;
}();
/**
 * Este parámetro identifica un grupo de mensajes (p. ej., con collapseKey: \"Updates Available\") que puede contraerse, para que solo se envíe el último mensaje cuando se reanuda la entrega. El propósito es no enviar demasiados mensajes iguales cuando el dispositivo se activa o vuelve a conectarse. Toma en cuenta que no puede garantizarse el orden en que se envían los mensajes. Nota: Se permite un máximo de 4 claves de contracción diferentes en cualquier momento. Esto significa que un servidor de conexiones de FCM puede almacenar simultáneamente 4 mensajes Send-to-Sync por app cliente. Si superas esta cantidad, no hay ninguna garantía de cuáles serán las 4 claves de contracción que conservará el servidor de conexiones de FCM. La clave no puede ser una palabra reservada, por ejemplo \"from\", cualquier palabra que comience por \"google\" o \"gcm\", o cualquiera de las propiedades de este esquema
 * @member {String} collapseKey
 */


SendNotificationOptions.prototype['collapseKey'] = undefined;
/**
 * Establece la prioridad del mensaje. Los valores válidos son 'normal' y 'high'. En iOS, estos corresponden a prioridad de APNS de 5 y 10. En forma predeterminada, los mensajes de notificación se envían con prioridad alta y los mensajes de datos se envían con prioridad normal. La prioridad normal optimiza el consumo de la batería de la app cliente y debe usarse salvo que el mensaje deba entregarse en forma inmediata. En el caso de los mensajes con prioridad normal, la app puede recibir los mensajes con una demora no específica. Los mensajes con prioridad alta se envían inmediatamente, y la app puede despertar un dispositivo suspendido y abrir una conexión de red a tu servidor
 * @member {String} priority
 */

SendNotificationOptions.prototype['priority'] = undefined;
/**
 * En iOS, usa este campo para representar content-available en la carga útil de APNS. Cuando se envía una notificación o un mensaje y el valor del campo es true, se despierta una app cliente inactiva. En Android, los mensajes de datos despiertan a la app de forma predeterminada. En Chrome, no se admite actualmente
 * @member {Boolean} contentAvailable
 */

SendNotificationOptions.prototype['contentAvailable'] = undefined;
/**
 * Actualmente, está disponible solo para dispositivos con iOS 10 y versiones más recientes. En iOS, usa este campo para representar mutable-content en la carga útil de APNS. Cuando se envía una notificación y el valor de este parámetro es true, el contenido de la notificación se puede modificar antes de mostrarse por medio de una extensión de aplicación del servicio de notificaciones (NotificationServiceExtension). Este parámetro se ignorará en Android y Web
 * @member {Boolean} mutableContent
 */

SendNotificationOptions.prototype['mutableContent'] = undefined;
/**
 * Este parámetro especifica el tiempo (en segundos) que el mensaje se debe conservar en el almacenamiento de FCM si el dispositivo se encuentra sin conexión. El tiempo de vida máximo admitido es de 4 semanas y el valor predeterminado es de 4 semanas
 * @member {Number} timeToLive
 * @default 2419200
 */

SendNotificationOptions.prototype['timeToLive'] = 2419200;
/**
 * Este parámetro especifica el nombre del paquete de la aplicación donde los token de registro deben coincidir para recibir el mensaje. Por defecto no se controla que un registrationToken pertenezca a una app concreta para hacer el envío. Utilizando este parámetro se puede obligar a Firebase para que haga la comprobación
 * @member {String} restrictedPackageName
 */

SendNotificationOptions.prototype['restrictedPackageName'] = undefined;
/**
 * Cuando el valor de este parámetro es true, los programadores pueden probar una solicitud sin enviar realmente un mensaje
 * @member {Boolean} dryRun
 */

SendNotificationOptions.prototype['dryRun'] = undefined;
var _default = SendNotificationOptions;
exports["default"] = _default;