@nethesis/astproxy/lib/confBridgeConference.js

Node.js proxy for Asterisk PBX

/**
 * Abstraction of a ConfBridge conference.
 *
 * **It can throw exceptions.**
 *
 * @class ConfBridgeConference
 * @param {string} extOwner The identifier of the extension owner
 * @return {object} The ConfBridge conference object.
 * @constructor
 */
exports.ConfBridgeConference = function (extOwner) {
  // check the parameter
  if (typeof extOwner !== 'string') {
    throw new Error('wrong parameters: ' + JSON.stringify(arguments));
  }

  /**
   * The Extension owner id.
   *
   * @property id
   * @type {string}
   * @required
   * @private
   */
  var id = extOwner;

  /**
   * The user of the conference. They are extensions. Keys are user
   * identifiers and the values are the _ConfBridgeConfUser_ object.
   *
   * @property users
   * @type object
   * @private
   * @default {}
   */
  var users = {};

  /**
   * Returns the identifier of the extension owner.
   *
   * @method getId
   * @return {string} The identifier of the extension owner
   */
  function getId() {
    return id;
  }

  /**
   * Returns the number of participating users.
   *
   * @method getUsersCount
   * @return {number} The number of participating users.
   */
  function getUsersCount() {
    return Object.keys(users).length;
  }

  /**
   * Adds a user to the conference.
   *
   * @method addUser
   * @param {object} obj A _ConfBridgeConfUser_ object
   */
  function addUser(obj) {
    var prefix = obj.getRemoteSitePrefix() ? obj.getRemoteSitePrefix() : '';
    users[prefix + obj.getExtenId()] = obj;
  }

  /**
   * Returns the user of the conference.
   *
   * @method getUser
   * @param  {string} extenId The extension identifier
   * @return {object} The user of the conference.
   */
  function getUser(extenId) {
    return users[extenId];
  }

  /**
   * Returns the extension id of the user.
   *
   * @method getExtenId
   * @param {string} userId The user identifier
   * @return {string} The extension id of the user.
   */
  function getExtenId(userId) {
    for (var exten in users) {
      if (users[exten].getId() === userId) {
        return users[exten].getExtenId();
      }
    }
  }

  /**
   * Returns all the users of the conference.
   *
   * @method getAllUsers
   * @return {object} All the users of the conference.
   */
  function getAllUsers() {
    return users;
  }

  /**
   * Returns true if the extension is in the conference.
   *
   * @method hasExten
   * @param  {string}  extenId The extension identifier
   * @return {boolean} True if the extension is in the conference.
   */
  function hasExten(extenId) {
    if (users[extenId]) {
      return true;
    }
    return false;
  }

  /**
   * Returns the readable string of the conference.
   *
   * @method toString
   * @return {string} The readable description of the conference
   */
  function toString() {
    return 'ConfBridge conference - owner "' + getOwnerId() + '" with ' + getUsersCount() + ' users';
  }

  /**
   * Returns the JSON representation of the object.
   *
   *     {
   *         id: "202",
   *         users: { ConfBridgeConfUser.toJSON(), ... } // the keys are the ConfBridge conference user identifiers
   *     }
   *
   * @method toJSON
   * @return {object} The JSON representation of the object.
   */
  function toJSON() {

    var jsonUsers = {};
    var u;

    // JSON representation of the users
    for (u in users) {
      jsonUsers[u] = users[u].toJSON();
    }

    return {
      id: id,
      users: jsonUsers
    };
  }

  // public interface
  return {
    getId: getId,
    toJSON: toJSON,
    addUser: addUser,
    getUser: getUser,
    hasExten: hasExten,
    toString: toString,
    getExtenId: getExtenId,
    getAllUsers: getAllUsers,
    getUsersCount: getUsersCount
  };
};