Source: rest/video/v1/room/roomParticipant/roomParticipantPublishedTrack.js

  1. 'use strict';
  3. /* jshint ignore:start */
  4. /**
  5.  * This code was generated by
  6.  * \ / _    _  _|   _  _
  7.  *  | (_)\/(_)(_|\/| |(/_  v1.0.0
  8.  *       /       /
  9.  */
  10. /* jshint ignore:end */
  12. var Q = require('q');  /* jshint ignore:line */
  13. var _ = require('lodash');  /* jshint ignore:line */
  14. var util = require('util');  /* jshint ignore:line */
  15. var Page = require('../../../../../base/Page');  /* jshint ignore:line */
  16. var deserialize = require(
  17.     '../../../../../base/deserialize');  /* jshint ignore:line */
  18. var values = require('../../../../../base/values');  /* jshint ignore:line */
  20. var PublishedTrackList;
  21. var PublishedTrackPage;
  22. var PublishedTrackInstance;
  23. var PublishedTrackContext;
  25. /* jshint ignore:start */
  26. /**
  27.  * Initialize the PublishedTrackList
  28.  *
  29.  * @constructor Twilio.Video.V1.RoomContext.ParticipantContext.PublishedTrackList
  30.  *
  31.  * @param {Twilio.Video.V1} version - Version of the resource
  32.  * @param {string} roomSid -
  33.  *          The SID of the Room resource where the track is published
  34.  * @param {string} participantSid -
  35.  *          The SID of the Participant resource with the published track
  36.  */
  37. /* jshint ignore:end */
  38. PublishedTrackList = function PublishedTrackList(version, roomSid,
  39.                                                   participantSid) {
  40.   /* jshint ignore:start */
  41.   /**
  42.    * @function publishedTracks
  43.    * @memberof Twilio.Video.V1.RoomContext.ParticipantContext#
  44.    *
  45.    * @param {string} sid - sid of instance
  46.    *
  47.    * @returns {Twilio.Video.V1.RoomContext.ParticipantContext.PublishedTrackContext}
  48.    */
  49.   /* jshint ignore:end */
  50.   function PublishedTrackListInstance(sid) {
  51.     return PublishedTrackListInstance.get(sid);
  52.   }
  54.   PublishedTrackListInstance._version = version;
  55.   // Path Solution
  56.   PublishedTrackListInstance._solution = {roomSid: roomSid, participantSid: participantSid};
  57.   PublishedTrackListInstance._uri = `/Rooms/${roomSid}/Participants/${participantSid}/PublishedTracks`;
  58.   /* jshint ignore:start */
  59.   /**
  60.    * Streams PublishedTrackInstance records from the API.
  61.    *
  62.    * This operation lazily loads records as efficiently as possible until the limit
  63.    * is reached.
  64.    *
  65.    * The results are passed into the callback function, so this operation is memory
  66.    * efficient.
  67.    *
  68.    * If a function is passed as the first argument, it will be used as the callback
  69.    * function.
  70.    *
  71.    * @function each
  72.    * @memberof Twilio.Video.V1.RoomContext.ParticipantContext.PublishedTrackList#
  73.    *
  74.    * @param {object} [opts] - Options for request
  75.    * @param {number} [opts.limit] -
  76.    *         Upper limit for the number of records to return.
  77.    *         each() guarantees never to return more than limit.
  78.    *         Default is no limit
  79.    * @param {number} [opts.pageSize] -
  80.    *         Number of records to fetch per request,
  81.    *         when not set will use the default value of 50 records.
  82.    *         If no pageSize is defined but a limit is defined,
  83.    *         each() will attempt to read the limit with the most efficient
  84.    *         page size, i.e. min(limit, 1000)
  85.    * @param {Function} [opts.callback] -
  86.    *         Function to process each record. If this and a positional
  87.    *         callback are passed, this one will be used
  88.    * @param {Function} [opts.done] -
  89.    *          Function to be called upon completion of streaming
  90.    * @param {Function} [callback] - Function to process each record
  91.    */
  92.   /* jshint ignore:end */
  93.   PublishedTrackListInstance.each = function each(opts, callback) {
  94.     if (_.isFunction(opts)) {
  95.       callback = opts;
  96.       opts = {};
  97.     }
  98.     opts = opts || {};
  99.     if (opts.callback) {
  100.       callback = opts.callback;
  101.     }
  102.     if (_.isUndefined(callback)) {
  103.       throw new Error('Callback function must be provided');
  104.     }
  106.     var done = false;
  107.     var currentPage = 1;
  108.     var currentResource = 0;
  109.     var limits = this._version.readLimits({
  110.       limit: opts.limit,
  111.       pageSize: opts.pageSize
  112.     });
  114.     function onComplete(error) {
  115.       done = true;
  116.       if (_.isFunction(opts.done)) {
  117.         opts.done(error);
  118.       }
  119.     }
  121.     function fetchNextPage(fn) {
  122.       var promise = fn();
  123.       if (_.isUndefined(promise)) {
  124.         onComplete();
  125.         return;
  126.       }
  128.       promise.then(function(page) {
  129.         _.each(page.instances, function(instance) {
  130.           if (done || (!_.isUndefined(opts.limit) && currentResource >= opts.limit)) {
  131.             done = true;
  132.             return false;
  133.           }
  135.           currentResource++;
  136.           callback(instance, onComplete);
  137.         });
  139.         if (!done) {
  140.           currentPage++;
  141.           fetchNextPage(_.bind(page.nextPage, page));
  142.         }
  143.       });
  145.       promise.catch(onComplete);
  146.     }
  148.     fetchNextPage(_.bind(this.page, this, _.merge(opts, limits)));
  149.   };
  151.   /* jshint ignore:start */
  152.   /**
  153.    * Lists PublishedTrackInstance records from the API as a list.
  154.    *
  155.    * If a function is passed as the first argument, it will be used as the callback
  156.    * function.
  157.    *
  158.    * @function list
  159.    * @memberof Twilio.Video.V1.RoomContext.ParticipantContext.PublishedTrackList#
  160.    *
  161.    * @param {object} [opts] - Options for request
  162.    * @param {number} [opts.limit] -
  163.    *         Upper limit for the number of records to return.
  164.    *         list() guarantees never to return more than limit.
  165.    *         Default is no limit
  166.    * @param {number} [opts.pageSize] -
  167.    *         Number of records to fetch per request,
  168.    *         when not set will use the default value of 50 records.
  169.    *         If no page_size is defined but a limit is defined,
  170.    *         list() will attempt to read the limit with the most
  171.    *         efficient page size, i.e. min(limit, 1000)
  172.    * @param {function} [callback] - Callback to handle list of records
  173.    *
  174.    * @returns {Promise} Resolves to a list of records
  175.    */
  176.   /* jshint ignore:end */
  177.   PublishedTrackListInstance.list = function list(opts, callback) {
  178.     if (_.isFunction(opts)) {
  179.       callback = opts;
  180.       opts = {};
  181.     }
  182.     opts = opts || {};
  183.     var deferred = Q.defer();
  184.     var allResources = [];
  185.     opts.callback = function(resource, done) {
  186.       allResources.push(resource);
  188.       if (!_.isUndefined(opts.limit) && allResources.length === opts.limit) {
  189.         done();
  190.       }
  191.     };
  193.     opts.done = function(error) {
  194.       if (_.isUndefined(error)) {
  195.         deferred.resolve(allResources);
  196.       } else {
  197.         deferred.reject(error);
  198.       }
  199.     };
  201.     if (_.isFunction(callback)) {
  202.       deferred.promise.nodeify(callback);
  203.     }
  205.     this.each(opts);
  206.     return deferred.promise;
  207.   };
  209.   /* jshint ignore:start */
  210.   /**
  211.    * Retrieve a single page of PublishedTrackInstance records from the API.
  212.    *
  213.    * The request is executed immediately.
  214.    *
  215.    * If a function is passed as the first argument, it will be used as the callback
  216.    * function.
  217.    *
  218.    * @function page
  219.    * @memberof Twilio.Video.V1.RoomContext.ParticipantContext.PublishedTrackList#
  220.    *
  221.    * @param {object} [opts] - Options for request
  222.    * @param {string} [opts.pageToken] - PageToken provided by the API
  223.    * @param {number} [opts.pageNumber] -
  224.    *          Page Number, this value is simply for client state
  225.    * @param {number} [opts.pageSize] - Number of records to return, defaults to 50
  226.    * @param {function} [callback] - Callback to handle list of records
  227.    *
  228.    * @returns {Promise} Resolves to a list of records
  229.    */
  230.   /* jshint ignore:end */
  231.   PublishedTrackListInstance.page = function page(opts, callback) {
  232.     if (_.isFunction(opts)) {
  233.       callback = opts;
  234.       opts = {};
  235.     }
  236.     opts = opts || {};
  238.     var deferred = Q.defer();
  239.     var data = values.of({
  240.       'PageToken': opts.pageToken,
  241.       'Page': opts.pageNumber,
  242.       'PageSize': opts.pageSize
  243.     });
  245.     var promise = this._version.page({uri: this._uri, method: 'GET', params: data});
  247.     promise = promise.then(function(payload) {
  248.       deferred.resolve(new PublishedTrackPage(this._version, payload, this._solution));
  249.     }.bind(this));
  251.     promise.catch(function(error) {
  252.       deferred.reject(error);
  253.     });
  255.     if (_.isFunction(callback)) {
  256.       deferred.promise.nodeify(callback);
  257.     }
  259.     return deferred.promise;
  260.   };
  262.   /* jshint ignore:start */
  263.   /**
  264.    * Retrieve a single target page of PublishedTrackInstance records from the API.
  265.    *
  266.    * The request is executed immediately.
  267.    *
  268.    * If a function is passed as the first argument, it will be used as the callback
  269.    * function.
  270.    *
  271.    * @function getPage
  272.    * @memberof Twilio.Video.V1.RoomContext.ParticipantContext.PublishedTrackList#
  273.    *
  274.    * @param {string} [targetUrl] - API-generated URL for the requested results page
  275.    * @param {function} [callback] - Callback to handle list of records
  276.    *
  277.    * @returns {Promise} Resolves to a list of records
  278.    */
  279.   /* jshint ignore:end */
  280.   PublishedTrackListInstance.getPage = function getPage(targetUrl, callback) {
  281.     var deferred = Q.defer();
  283.     var promise = this._version._domain.twilio.request({method: 'GET', uri: targetUrl});
  285.     promise = promise.then(function(payload) {
  286.       deferred.resolve(new PublishedTrackPage(this._version, payload, this._solution));
  287.     }.bind(this));
  289.     promise.catch(function(error) {
  290.       deferred.reject(error);
  291.     });
  293.     if (_.isFunction(callback)) {
  294.       deferred.promise.nodeify(callback);
  295.     }
  297.     return deferred.promise;
  298.   };
  300.   /* jshint ignore:start */
  301.   /**
  302.    * Constructs a published_track
  303.    *
  304.    * @function get
  305.    * @memberof Twilio.Video.V1.RoomContext.ParticipantContext.PublishedTrackList#
  306.    *
  307.    * @param {string} sid - The SID that identifies the resource to fetch
  308.    *
  309.    * @returns {Twilio.Video.V1.RoomContext.ParticipantContext.PublishedTrackContext}
  310.    */
  311.   /* jshint ignore:end */
  312.   PublishedTrackListInstance.get = function get(sid) {
  313.     return new PublishedTrackContext(
  314.       this._version,
  315.       this._solution.roomSid,
  316.       this._solution.participantSid,
  317.       sid
  318.     );
  319.   };
  321.   /* jshint ignore:start */
  322.   /**
  323.    * Provide a user-friendly representation
  324.    *
  325.    * @function toJSON
  326.    * @memberof Twilio.Video.V1.RoomContext.ParticipantContext.PublishedTrackList#
  327.    *
  328.    * @returns Object
  329.    */
  330.   /* jshint ignore:end */
  331.   PublishedTrackListInstance.toJSON = function toJSON() {
  332.     return this._solution;
  333.   };
  335.   PublishedTrackListInstance[util.inspect.custom] = function inspect(depth,
  336.       options) {
  337.     return util.inspect(this.toJSON(), options);
  338.   };
  340.   return PublishedTrackListInstance;
  341. };
  344. /* jshint ignore:start */
  345. /**
  346.  * Initialize the PublishedTrackPage
  347.  *
  348.  * @constructor Twilio.Video.V1.RoomContext.ParticipantContext.PublishedTrackPage
  349.  *
  350.  * @param {V1} version - Version of the resource
  351.  * @param {Response<string>} response - Response from the API
  352.  * @param {PublishedTrackSolution} solution - Path solution
  353.  *
  354.  * @returns PublishedTrackPage
  355.  */
  356. /* jshint ignore:end */
  357. PublishedTrackPage = function PublishedTrackPage(version, response, solution) {
  358.   // Path Solution
  359.   this._solution = solution;
  361.   Page.prototype.constructor.call(this, version, response, this._solution);
  362. };
  364. _.extend(PublishedTrackPage.prototype, Page.prototype);
  365. PublishedTrackPage.prototype.constructor = PublishedTrackPage;
  367. /* jshint ignore:start */
  368. /**
  369.  * Build an instance of PublishedTrackInstance
  370.  *
  371.  * @function getInstance
  372.  * @memberof Twilio.Video.V1.RoomContext.ParticipantContext.PublishedTrackPage#
  373.  *
  374.  * @param {PublishedTrackPayload} payload - Payload response from the API
  375.  *
  376.  * @returns PublishedTrackInstance
  377.  */
  378. /* jshint ignore:end */
  379. PublishedTrackPage.prototype.getInstance = function getInstance(payload) {
  380.   return new PublishedTrackInstance(
  381.     this._version,
  382.     payload,
  383.     this._solution.roomSid,
  384.     this._solution.participantSid
  385.   );
  386. };
  388. /* jshint ignore:start */
  389. /**
  390.  * Provide a user-friendly representation
  391.  *
  392.  * @function toJSON
  393.  * @memberof Twilio.Video.V1.RoomContext.ParticipantContext.PublishedTrackPage#
  394.  *
  395.  * @returns Object
  396.  */
  397. /* jshint ignore:end */
  398. PublishedTrackPage.prototype.toJSON = function toJSON() {
  399.   let clone = {};
  400.   _.forOwn(this, function(value, key) {
  401.     if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
  402.       clone[key] = value;
  403.     }
  404.   });
  405.   return clone;
  406. };
  408. PublishedTrackPage.prototype[util.inspect.custom] = function inspect(depth,
  409.     options) {
  410.   return util.inspect(this.toJSON(), options);
  411. };
  414. /* jshint ignore:start */
  415. /**
  416.  * Initialize the PublishedTrackContext
  417.  *
  418.  * @constructor Twilio.Video.V1.RoomContext.ParticipantContext.PublishedTrackInstance
  419.  *
  420.  * @property {string} sid - The unique string that identifies the resource
  421.  * @property {string} participantSid -
  422.  *          The SID of the Participant resource with the published track
  423.  * @property {string} roomSid -
  424.  *          The SID of the Room resource where the track is published
  425.  * @property {string} name - The track name
  426.  * @property {Date} dateCreated -
  427.  *          The ISO 8601 date and time in GMT when the resource was created
  428.  * @property {Date} dateUpdated -
  429.  *          The ISO 8601 date and time in GMT when the resource was last updated
  430.  * @property {boolean} enabled - Whether the track is enabled
  431.  * @property {published_track.kind} kind - The track type
  432.  * @property {string} url - The absolute URL of the resource
  433.  *
  434.  * @param {V1} version - Version of the resource
  435.  * @param {PublishedTrackPayload} payload - The instance payload
  436.  * @param {sid} roomSid - The SID of the Room resource where the track is published
  437.  * @param {sid} participantSid -
  438.  *          The SID of the Participant resource with the published track
  439.  * @param {sid_like} sid - The SID that identifies the resource to fetch
  440.  */
  441. /* jshint ignore:end */
  442. PublishedTrackInstance = function PublishedTrackInstance(version, payload,
  443.                                                           roomSid,
  444.                                                           participantSid, sid) {
  445.   this._version = version;
  447.   // Marshaled Properties
  448.   this.sid = payload.sid; // jshint ignore:line
  449.   this.participantSid = payload.participant_sid; // jshint ignore:line
  450.   this.roomSid = payload.room_sid; // jshint ignore:line
  451.   this.name = payload.name; // jshint ignore:line
  452.   this.dateCreated = deserialize.iso8601DateTime(payload.date_created); // jshint ignore:line
  453.   this.dateUpdated = deserialize.iso8601DateTime(payload.date_updated); // jshint ignore:line
  454.   this.enabled = payload.enabled; // jshint ignore:line
  455.   this.kind = payload.kind; // jshint ignore:line
  456.   this.url = payload.url; // jshint ignore:line
  458.   // Context
  459.   this._context = undefined;
  460.   this._solution = {roomSid: roomSid, participantSid: participantSid, sid: sid || this.sid, };
  461. };
  463. Object.defineProperty(PublishedTrackInstance.prototype,
  464.   '_proxy', {
  465.     get: function() {
  466.       if (!this._context) {
  467.         this._context = new PublishedTrackContext(
  468.           this._version,
  469.           this._solution.roomSid,
  470.           this._solution.participantSid,
  471.           this._solution.sid
  472.         );
  473.       }
  475.       return this._context;
  476.     }
  477. });
  479. /* jshint ignore:start */
  480. /**
  481.  * fetch a PublishedTrackInstance
  482.  *
  483.  * @function fetch
  484.  * @memberof Twilio.Video.V1.RoomContext.ParticipantContext.PublishedTrackInstance#
  485.  *
  486.  * @param {function} [callback] - Callback to handle processed record
  487.  *
  488.  * @returns {Promise} Resolves to processed PublishedTrackInstance
  489.  */
  490. /* jshint ignore:end */
  491. PublishedTrackInstance.prototype.fetch = function fetch(callback) {
  492.   return this._proxy.fetch(callback);
  493. };
  495. /* jshint ignore:start */
  496. /**
  497.  * Provide a user-friendly representation
  498.  *
  499.  * @function toJSON
  500.  * @memberof Twilio.Video.V1.RoomContext.ParticipantContext.PublishedTrackInstance#
  501.  *
  502.  * @returns Object
  503.  */
  504. /* jshint ignore:end */
  505. PublishedTrackInstance.prototype.toJSON = function toJSON() {
  506.   let clone = {};
  507.   _.forOwn(this, function(value, key) {
  508.     if (!_.startsWith(key, '_') && ! _.isFunction(value)) {
  509.       clone[key] = value;
  510.     }
  511.   });
  512.   return clone;
  513. };
  515. PublishedTrackInstance.prototype[util.inspect.custom] = function inspect(depth,
  516.     options) {
  517.   return util.inspect(this.toJSON(), options);
  518. };
  521. /* jshint ignore:start */
  522. /**
  523.  * Initialize the PublishedTrackContext
  524.  *
  525.  * @constructor Twilio.Video.V1.RoomContext.ParticipantContext.PublishedTrackContext
  526.  *
  527.  * @param {V1} version - Version of the resource
  528.  * @param {sid_like} roomSid -
  529.  *          The SID of the Room resource where the Track resource to fetch is published
  530.  * @param {sid_like} participantSid -
  531.  *          The SID of the Participant resource with the published track to fetch
  532.  * @param {sid_like} sid - The SID that identifies the resource to fetch
  533.  */
  534. /* jshint ignore:end */
  535. PublishedTrackContext = function PublishedTrackContext(version, roomSid,
  536.                                                         participantSid, sid) {
  537.   this._version = version;
  539.   // Path Solution
  540.   this._solution = {roomSid: roomSid, participantSid: participantSid, sid: sid, };
  541.   this._uri = `/Rooms/${roomSid}/Participants/${participantSid}/PublishedTracks/${sid}`;
  542. };
  544. /* jshint ignore:start */
  545. /**
  546.  * fetch a PublishedTrackInstance
  547.  *
  548.  * @function fetch
  549.  * @memberof Twilio.Video.V1.RoomContext.ParticipantContext.PublishedTrackContext#
  550.  *
  551.  * @param {function} [callback] - Callback to handle processed record
  552.  *
  553.  * @returns {Promise} Resolves to processed PublishedTrackInstance
  554.  */
  555. /* jshint ignore:end */
  556. PublishedTrackContext.prototype.fetch = function fetch(callback) {
  557.   var deferred = Q.defer();
  558.   var promise = this._version.fetch({uri: this._uri, method: 'GET'});
  560.   promise = promise.then(function(payload) {
  561.     deferred.resolve(new PublishedTrackInstance(
  562.       this._version,
  563.       payload,
  564.       this._solution.roomSid,
  565.       this._solution.participantSid,
  566.       this._solution.sid
  567.     ));
  568.   }.bind(this));
  570.   promise.catch(function(error) {
  571.     deferred.reject(error);
  572.   });
  574.   if (_.isFunction(callback)) {
  575.     deferred.promise.nodeify(callback);
  576.   }
  578.   return deferred.promise;
  579. };
  581. /* jshint ignore:start */
  582. /**
  583.  * Provide a user-friendly representation
  584.  *
  585.  * @function toJSON
  586.  * @memberof Twilio.Video.V1.RoomContext.ParticipantContext.PublishedTrackContext#
  587.  *
  588.  * @returns Object
  589.  */
  590. /* jshint ignore:end */
  591. PublishedTrackContext.prototype.toJSON = function toJSON() {
  592.   return this._solution;
  593. };
  595. PublishedTrackContext.prototype[util.inspect.custom] = function inspect(depth,
  596.     options) {
  597.   return util.inspect(this.toJSON(), options);
  598. };
  600. module.exports = {
  601.   PublishedTrackList: PublishedTrackList,
  602.   PublishedTrackPage: PublishedTrackPage,
  603.   PublishedTrackInstance: PublishedTrackInstance,
  604.   PublishedTrackContext: PublishedTrackContext
  605. };