Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

constructor

Properties

fallbackRequestHandler

fallbackRequestHandler: FallbackRequestHandler

Optional headers

headers?: Record<string, unknown>

Optional host

host?: string

logger

Optional pathPrefix

pathPrefix?: string

Static domainHolder

domainHolder: DomainHolder

Methods

deleteBatchUserProperties

  • deleteBatchUserProperties(__namedParameters: { data: { cause?: any; properties: string[]; userUuid: string }[]; roomUuid: string }): Promise<any>
  • Parameters

    • __namedParameters: { data: { cause?: any; properties: string[]; userUuid: string }[]; roomUuid: string }
      • data: { cause?: any; properties: string[]; userUuid: string }[]
      • roomUuid: string

    Returns Promise<any>

deleteRoomProperties

  • deleteRoomProperties(__namedParameters: { cause?: unknown; properties: string[]; roomUuid: string }): Promise<any>
  • Parameters

    • __namedParameters: { cause?: unknown; properties: string[]; roomUuid: string }
      • Optional cause?: unknown
      • properties: string[]
      • roomUuid: string

    Returns Promise<any>

deleteStream

  • deleteStream(roomUuid: string, userUuid: string, streamUuid: string): Promise<any>
  • Parameters

    • roomUuid: string
    • userUuid: string
    • streamUuid: string

    Returns Promise<any>

deleteUserProperties

  • deleteUserProperties(__namedParameters: { cause?: any; properties: string[]; roomUuid: string; userUuid: string }): Promise<any>
  • Parameters

    • __namedParameters: { cause?: any; properties: string[]; roomUuid: string; userUuid: string }
      • Optional cause?: any
      • properties: string[]
      • roomUuid: string
      • userUuid: string

    Returns Promise<any>

entryRoom

fetch

publishStreamToCdn

  • publishStreamToCdn(roomUuid: string, userUuid: string, streamUuid: string, params: PublishCdnParams): Promise<any>
  • Parameters

    Returns Promise<any>

sendCustomChannelMessage

  • sendCustomChannelMessage(roomUuid: string, payload: { cmd: string; data: any }, sync?: boolean): Promise<any>
  • Parameters

    • roomUuid: string
    • payload: { cmd: string; data: any }
      • cmd: string
      • data: any
    • Optional sync: boolean

    Returns Promise<any>

sendCustomPeerMessage

  • sendCustomPeerMessage(roomUuid: string, payload: { cmd: string; data: any }, toUserUuid: string, waitForAck?: boolean): Promise<any>
  • Parameters

    • roomUuid: string
    • payload: { cmd: string; data: any }
      • cmd: string
      • data: any
    • toUserUuid: string
    • Optional waitForAck: boolean

    Returns Promise<any>

sendRoomChatMessage

  • sendRoomChatMessage(message: string, roomUuid: string): Promise<any>
  • Parameters

    • message: string
    • roomUuid: string

    Returns Promise<any>

syncPeerSequence

  • syncPeerSequence(roomUuid: string, userUuid: string, seqId: number, count: number): Promise<any>
  • Parameters

    • roomUuid: string
    • userUuid: string
    • seqId: number
    • count: number

    Returns Promise<any>

syncSequence

  • syncSequence(roomUuid: string, seqId: number, count: number): Promise<any>
  • Parameters

    • roomUuid: string
    • seqId: number
    • count: number

    Returns Promise<any>

updateBatchUserProperties

  • updateBatchUserProperties(__namedParameters: { data: { cause?: any; properties: unknown; userUuid: string }[]; roomUuid: string }): Promise<any>
  • Parameters

    • __namedParameters: { data: { cause?: any; properties: unknown; userUuid: string }[]; roomUuid: string }
      • data: { cause?: any; properties: unknown; userUuid: string }[]
      • roomUuid: string

    Returns Promise<any>

updateDeviceState

updateOnlineState

  • updateOnlineState(__namedParameters: { roomUuid: string; userUuid: string }): Promise<any>
  • Parameters

    • __namedParameters: { roomUuid: string; userUuid: string }
      • roomUuid: string
      • userUuid: string

    Returns Promise<any>

updateRoomProperties

  • updateRoomProperties(__namedParameters: { cause?: unknown; properties: unknown; roomUuid: string }): Promise<any>
  • Parameters

    • __namedParameters: { cause?: unknown; properties: unknown; roomUuid: string }
      • Optional cause?: unknown
      • properties: unknown
      • roomUuid: string

    Returns Promise<any>

updateUserProperties

  • updateUserProperties(__namedParameters: { cause?: any; properties: unknown; roomUuid: string; userUuid: string }): Promise<any>
  • Parameters

    • __namedParameters: { cause?: any; properties: unknown; roomUuid: string; userUuid: string }
      • Optional cause?: any
      • properties: unknown
      • roomUuid: string
      • userUuid: string

    Returns Promise<any>

upsertStream

upsertStreamBatch