Room

Create Room

function createRoom(string $name, bool $isPublic = false, array $invitees = [])

Parameters:

NameTypeDescriptionRequired

name

string

room name

true

isPublic

string

public or private

false

invitees

string array

array of user ids to invite

false

Returns:

NameTypeDescriptionRequired

room

Room

Room Object

true

Join Room

function joinRoom(string $roomIdOrAlias)

Parameters:

NameTypeDescriptionRequired

roomIdOrAlias

string

room id or alias

true

Returns:

NameTypeDescriptionRequired

room

Room

Room Object

true

Get Room Object

function getRoom(string $roomId)

Parameters:

NameTypeDescriptionRequired

roomId

string

room id

true

Returns:

NameTypeDescriptionRequired

room

Room

Room Object

true

Invite User

function inviteUser(string $userId)

Parameters:

NameTypeDescriptionRequired

userId

string

user id

true

Returns: none

Kick User

function kickUser(string $userId)

Parameters:

NameTypeDescriptionRequired

userId

string

user id

true

Returns: none

Leave Room

function leave()

input params:none

Returns: none

Get Room Memebers

 function getJoinedMembers()

Parameters: none

Returns:

NameTypeDescriptionRequired

roomMemberInfo

array of members

room member info

true

Send Message

function sendText(string $text)

Parameters:

NameTypeDescriptionRequired

text

string

message to send

true

Returns:

NameTypeDescriptionRequired

eventId

string

event id

true

Last updated