API Docs for:
Show:

MeetmeConference Class

Module: astproxy

Abstraction of a meetme conference.

It can throw exceptions.

Constructor

MeetmeConference

(
  • extOwner
)
Object

Parameters:

  • extOwner String

    The identifier of the extension owner

Returns:

Object:

The meetme conference object.

Methods

addUser

(
  • obj
)

Adds a user to the conference.

Parameters:

  • obj Object

    A MeetmeConfUser object

getAllUsers

() Object

Returns all the users of the conference.

Returns:

Object:

All the users of the conference.

getExtenId

(
  • userId
)
String

Returns the extension id of the user.

Parameters:

  • userId String

    The user identifier

Returns:

String:

The extension id of the user.

getId

() String

Returns the identifier of the extension owner.

Returns:

String:

The identifier of the extension owner

getUser

(
  • extenId
)
Object

Returns the user of the conference.

Parameters:

  • extenId String

    The extension identifier

Returns:

Object:

The user of the conference.

getUsersCount

() Number

Returns the number of participating users.

Returns:

Number:

The number of participating users.

hasExten

(
  • extenId
)
Boolean

Returns true if the extension is into the conference.

Parameters:

  • extenId String

    The extension identifier

Returns:

Boolean:

True if the extension is into the conference.

toJSON

() Object

Returns the JSON representation of the object.

{
    id: "202",
    users: { MeetmeConfUser.toJSON(), ... } // the keys is the meetme conference user identifiers
}

Returns:

Object:

The JSON representation of the object.

toString

() String

Returns the readable string of the conference.

Returns:

String:

The readable description of the conference

Properties

id

String private

The Extension owner id.

users

Object private

The user of the conference. They are extensions. Keys are user identifiers and the values are the MeetmeConfUser object.

Default: {}