Messages Class
Messages
Constructor
Messages
()
Methods
createRoom
(
async
-
company
-
params
-
callback
Create a new room
Parameters:
-
company
StringCompany ID
-
params
HashParameters
-
callback
StringCallback function
getRoomByApplication
(
async
-
company
-
applicationId
-
params
-
callback
Get a specific room by application ID
Parameters:
-
company
StringCompany ID
-
applicationId
IntegerApplication ID
-
params
HashParameters
-
callback
StringCallback function
getRoomByContract
(
async
-
company
-
contractId
-
params
-
callback
Get a specific room by contract ID
Parameters:
-
company
StringCompany ID
-
contractId
IntegerContract ID
-
params
HashParameters
-
callback
StringCallback function
getRoomByOffer
(
async
-
company
-
offerId
-
params
-
callback
Get a specific room by offer ID
Parameters:
-
company
StringCompany ID
-
offerId
IntegerOffer ID
-
params
HashParameters
-
callback
StringCallback function
getRoomDetails
(
async
-
company
-
roomId
-
params
-
callback
Get a specific room information
Parameters:
-
company
StringCompany ID
-
roomId
StringRoom ID
-
params
HashParameters
-
callback
StringCallback function
getRooms
(
async
-
company
-
params
-
callback
Retrieve rooms information
Parameters:
-
company
StringCompany ID
-
params
HashParameters
-
callback
StringCallback function
sendMessageToRoom
(
async
-
company
-
roomId
-
params
-
callback
Send a message to a room
Parameters:
-
company
StringCompany ID
-
roomId
StringRoom ID
-
params
HashParameters
-
callback
StringCallback function
updateRoomMetadata
(
async
-
company
-
roomId
-
params
-
callback
Update the metadata of a room
Parameters:
-
company
StringCompany ID
-
roomId
StringRoom ID
-
params
HashParameters
-
callback
StringCallback function
updateRoomSettings
(
async
-
company
-
roomId
-
username
-
params
-
callback
Update a room settings
Parameters:
-
company
StringCompany ID
-
roomId
StringRoom ID
-
username
StringUser ID
-
params
HashParameters
-
callback
StringCallback function
Properties
entryPoint
String
final
static
Default: api