Documentation

Class: Enterprise

Enterprise

Enterprise

This class refers to the user's enterprise.

new Enterprise()

Methods

<static> fetchEnterpriseInformation(bearerToken, options)

Fetch enterprise information from apiKey if available

Parameters:
Name Type Description
bearerToken string
options fetchEnterpriseInformationOptions
Returns:

Enterprise information in promise

Type
Promise.<EnterpriseInformation>

<static> fetchSiteAgents(siteKey, options)

Fetch agents from a site using its sitekey

Parameters:
Name Type Description
siteKey string
options fetchSiteAgentsOptions
Returns:

Enterprise information in promise

Type
Promise.<Array.<Agent>>

createPrivateConference(options)

Create a new private conference on the cloud

Parameters:
Name Type Description
options PrivateConferenceCreationOptions
Returns:

newly created private conference in promise

Type
Promise.<Conference>

getApiKey()

Returns this enterprise apiKey

Returns:

session

Type
string

getAvailableConferences()

Deprecated:
  • Returns enterprise conferences available to the user
Returns:

conference list in promise

Type
Promise.<Object.<string, Conference>>

getConference(name)

Returns a Conference for a given name.

Parameters:
Name Type Description
name string

A conference name.
Returns:

Conference on promise.

Type
Promise.<Conference>

getContacts()

Returns contact list for enterprise

Returns:

contact list

Type
Object.<string, Contact>

getId()

Returns this enterprise id

Returns:

id

Type
string

getSession()

Returns the session connected to this enterprise

Returns:

session

Type
Session

getTags(conference, options)

Returns the tag list associated to the enterprise represented by this one.

Parameters:
Name Type Description
conference Conference

Optional conference.
options object
Returns:
Type
Promise.<array.<EnterpriseTag>>

load()

A promise for loading enterprise data

Returns:
Type
Promise.<void>

uploadFile(file, options)

A promise for uploading a file to the cloud

Parameters:
Name Type Description
file Blob
options UploadOptions
Returns:

url in promise

Type
Promise.<string>