Room
Create Room
function createRoom(string $name, bool $isPublic = false, array $invitees = [])
Parameters:
Name
Type
Description
Required
name
string
room name
true
isPublic
string
public or private
false
invitees
string array
array of user ids to invite
false
Returns:
Name
Type
Description
Required
room
Room
Room Object
true
Join Room
function joinRoom(string $roomIdOrAlias)
Parameters:
Name
Type
Description
Required
roomIdOrAlias
string
room id or alias
true
Returns:
Name
Type
Description
Required
room
Room
Room Object
true
Get Room Object
function getRoom(string $roomId)
Parameters:
Name
Type
Description
Required
roomId
string
room id
true
Returns:
Name
Type
Description
Required
room
Room
Room Object
true
Invite User
function inviteUser(string $userId)
Parameters:
Name
Type
Description
Required
userId
string
user id
true
Returns: none
Kick User
function kickUser(string $userId)
Parameters:
Name
Type
Description
Required
userId
string
user id
true
Returns: none
Leave Room
function leave()
input params:none
Returns: none
Get Room Memebers
function getJoinedMembers()
Parameters: none
Returns:
Name
Type
Description
Required
roomMemberInfo
array of members
room member info
true
Send Message
function sendText(string $text)
Parameters:
Name
Type
Description
Required
text
string
message to send
true
Returns:
Name
Type
Description
Required
eventId
string
event id
true
Last updated