Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Enumeration members

ONLINE = 0

Type aliases

Callback: () => {}

Type declaration

    • (): {}
    • deprecated

      Returns {}

    PropertyKey: string | number | symbol
    Record<K, T>: { [ P in K]: T }

    Construct a type with a set of properties K of type T

    Type parameters

    • K: keyof any

    • T

    genericAction: { messageType: "RtmDataRequest"; type: "ping" | "pong" | "userData" }

    Type declaration

    • messageType: "RtmDataRequest"
    • type: "ping" | "pong" | "userData"
    messageObjectType: userDataType | muteRequest | genericAction
    muteRequest: { device: mutingDevice; isForceful: boolean; messageType: "MuteRequest"; mute: boolean; rtcId: number }

    Type declaration

    • device: mutingDevice
    • isForceful: boolean
    • messageType: "MuteRequest"
    • mute: boolean
    • rtcId: number
    userDataType: { agora: { rtc: string; rtm: string }; messageType: "UserData"; role: clientRoleRaw; rtcId: number; rtmId: string; uikit: { framework: string; platform: string; version: string }; username?: string }

    Type declaration

    • agora: { rtc: string; rtm: string }
      • rtc: string
      • rtm: string
    • messageType: "UserData"
    • role: clientRoleRaw
    • rtcId: number
    • rtmId: string
    • uikit: { framework: string; platform: string; version: string }
      • framework: string
      • platform: string
      • version: string
    • Optional username?: string

    Variables

    Object: ObjectConstructor

    Provides functionality common to all JavaScript objects.

    Generated using TypeDoc