Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ParticipantAPI

ParticipantAPI is an interface for video/audio chat participant actions.

Hierarchy

  • ParticipantAPI

Index

Constructors

Methods

Constructors

constructor

Methods

inviteCelebrity

  • inviteCelebrity(data?: any): Promise<void>

  • Used to invite a celebrity to the video/audio chat session using the token set by ParticipantAPI.setToken. Can reject with SDKError. If WT session is not available, rejects with SDKError with Errors.SESSION_NOT_FOUND code.

    Parameters

    • Optional data: any

      Arbitrary data(e.g. sync token, stream id and etc) that will be available in {@link Session.data}.

    Returns Promise<void>

isCelebrityInvited

  • isCelebrityInvited(): Promise<boolean>

  • Used to check if celebrity is invited to the video/audio chat session using the token set by ParticipantAPI.setToken. Request is retried multiple times in case of network error. Can reject with SDKError.

    Returns Promise<boolean>

setLogLevel

setToken

  • setToken(token: string): void

  • Used to set auth token.

    Parameters

    • token: string

      Watch together token used to connect to the video/audio chat session.

    Returns void

uninviteCelebrity

  • uninviteCelebrity(): Promise<void>

  • Used to uninvite a celebrity from the video/audio chat session using the token set by ParticipantAPI.setToken. Request is retried multiple times in case of network error. Can reject with SDKError.

    Returns Promise<void>