Interface rtmContext

Interface for RTM Context

Hierarchy

rtmContext

Index

Properties

Methods

Properties

popUpState

popUpState: popUpStateEnum

state to display pop up on remote mute request

rtmClient

rtmClient: RtmEngine

RTM Client instance

rtmStatus

rtmStatus: rtmStatusEnum

rtm connection status

setPopUpState

setPopUpState: NewType

set state to hide pop up

uidMap

uidMap: Record<number, string>

map with rtm uid for each rtc uid in the channel

userDataMap

userDataMap: <internal>.Object

map with userdata for each rtc uid in the channel

usernames

usernames: Record<string, string>

RTM usernames

Methods

sendChannelMessage

sendChannelMessage(msg: messageObjectType): void

- Defined in src/Contexts/RtmContext.tsx:92
send message to everyone in the channel

Parameters
- msg: messageObjectType
Returns void

sendMuteRequest

sendMuteRequest(device: mutingDevice, rtcId: number, mute: boolean): void

- Defined in src/Contexts/RtmContext.tsx:112
Send a mute request

Parameters
- device: mutingDevice
- rtcId: number
- mute: boolean
Returns void

sendPeerMessage

sendPeerMessage(msg: messageObjectType, uid: string): void

- Defined in src/Contexts/RtmContext.tsx:96
send message to a specific user

Parameters
- msg: messageObjectType
- uid: string
Returns void

Generated using TypeDoc