Interface ChatRoomConfig

Configuration options accepted by ChatRoom constructor.

Hierarchy

  • ChatRoomConfig

Properties

id? maxReconnectAttempts? regionOrUrl tokenProvider

Properties

Optional id

id?: string

Local room identifier, defaults to randomly generated UUID string.

Remarks

The parameter is useful in case you want to differentiate between various room instances, e.g. for logging purposes, when you have more than one room connection at the same time.

Optional maxReconnectAttempts

maxReconnectAttempts?: number

Number of times the room will automatically retry WebSocket connection in case of connection failures.

regionOrUrl

regionOrUrl: string

AWS region name (e.g. us-west-2) or WebSocket URL starting with wss:// or ws://.

tokenProvider

tokenProvider: ChatTokenProvider

Callback method called when ChatRoom requires a fresh IVS chat token.

Settings

Member Visibility

Theme

Generated using TypeDoc