Options
All
  • Public
  • Public/Protected
  • All
Menu

Module wechat-guest-sdk

Index

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

AllowDataType

AllowDataType: number | string | boolean | undefined | null | Date | Record<string | number, unknown>

EventTargetType

EventTargetType: string | number

事件名称只能用 string , number 两种类型之一

JuphoonWeChatConference

JuphoonWeChatConference: InnerJuphoonWeChatConference

JuphoonWeChatGuest

JuphoonWeChatGuest: InnerJuphoonWeChatGuest

ParticipantChangeParam

ParticipantChangeParam<T>: Partial<Record<keyof T, boolean>>

Type parameters

  • T

Primitives

Primitives: string | number | bigint | undefined | symbol | null

SignalData

SignalData: Record<string, unknown>

SocketSendDataType

SocketSendDataType: string | Record<string | number, unknown>

StompSocket

StompSocket: InnerBrowserStompSocket

TaskFunction

TaskFunction: (task: Task) => unknown

Type declaration

    • (task: Task): unknown

    • Parameters

      Returns unknown

WeChatConference

WeChatConference: InnerWeChatConference

WeChatGuest

WeChatGuest: InnerWeChatGuest

WeChatLocalStream

WeChatLocalStream: InnerWeChatLocalStream

WeChatRemoteStream

WeChatRemoteStream: InnerWeChatRemoteStream

WebRTCStream

WebRTCStream: InnerWebRTCStream

Variables

Charset

Charset: { LOWERCASE: string; NUMBER: string; UPPERCASE: string }

Type declaration

  • LOWERCASE: string
  • NUMBER: string
  • UPPERCASE: string

DetectorInstance

DetectorInstance: InnerDetector

JuphoonWeChatConference

JuphoonWeChatConference: InnerJuphoonWeChatConference

JuphoonWeChatGuest

JuphoonWeChatGuest: InnerJuphoonWeChatGuest

ProxyManagerInstance

ProxyManagerInstance: ProxyManager<Reportable>

ReporterManagerInstance

ReporterManagerInstance: ReporterManager

StateMachineManagerInstance

StateMachineManagerInstance: StateMachineManager<Controllable>

StompSocket

StompSocket: typeof InnerBrowserStompSocket

StorageManagerInstance

StorageManagerInstance: StorageManager

TYPE_COMPOSE

TYPE_COMPOSE: {}

组合类型定义

Type declaration

  • [key: string]: TYPE[]

TaskManagerInstance

TaskManagerInstance: TaskManager

WeChatConference

WeChatConference: typeof InnerWeChatConference

WeChatGuest

WeChatGuest: typeof InnerWeChatGuest

WeChatLocalStream

WeChatLocalStream: typeof InnerWeChatLocalStream

WeChatRemoteStream

WeChatRemoteStream: typeof InnerWeChatRemoteStream

WebRTCStream

WebRTCStream: typeof InnerWebRTCStream

isBrowser

isBrowser: boolean

isWeChat

isWeChat: boolean

Functions

StateMachineAutoConfig

  • StateMachineAutoConfig(init: string): ClassDecorator

  • Parameters

    • init: string

    Returns ClassDecorator

backoff

  • backoff(func: (abort: () => void, retryTimes: number, timeout: number) => unknown, maxTimes?: number, maximumBackoff?: number): () => void

  • 指数退避算法

    Parameters

    • func: (abort: () => void, retryTimes: number, timeout: number) => unknown

      重试函数

        • (abort: () => void, retryTimes: number, timeout: number): unknown

        • Parameters

          • abort: () => void
              • (): void

              • Returns void

          • retryTimes: number
          • timeout: number

          Returns unknown

    • Optional maxTimes: number

      最大重试次数

    • Optional maximumBackoff: number

      最大退避时间

    Returns () => void

    返回一个函数用于中断重试

clone

  • clone<T>(target: T): T

  • Type parameters

    • T

    Parameters

    • target: T

    Returns T

debounce

  • debounce(func: (...args: unknown[]) => unknown, delay?: number): (...args: unknown[]) => unknown

  • Parameters

    • func: (...args: unknown[]) => unknown
        • (...args: unknown[]): unknown

        • Parameters

          • Rest ...args: unknown[]

          Returns unknown

    • Optional delay: number

    Returns (...args: unknown[]) => unknown

      • (...args: unknown[]): unknown

      • Parameters

        • Rest ...args: unknown[]

        Returns unknown

deepMerge

  • deepMerge<T>(target: T, source: T): T

  • deep merge

    Type parameters

    • T

    Parameters

    • target: T
    • source: T

    Returns T

dispatchHandler

  • Parameters

    Returns (target: SignalHandler, propertyKey: string, descriptor: PropertyDescriptor) => void

      • (target: SignalHandler, propertyKey: string, descriptor: PropertyDescriptor): void

      • Parameters

        • target: SignalHandler
        • propertyKey: string
        • descriptor: PropertyDescriptor

        Returns void

generateDeviceId

  • generateDeviceId(): string

  • 获取设备唯一Id

    Returns string

isIpAddress

  • isIpAddress(hostname: string): boolean

  • Parameters

    • hostname: string

    Returns boolean

isStats

  • isStats(str: string): boolean

  • Parameters

    • str: string

    Returns boolean

match

  • match(str: string, expression: string): boolean

  • 字符串正则匹配

    Parameters

    • str: string

      需要匹配的字符串

    • expression: string

      模式串

    Returns boolean

notUAN

  • notUAN<T>(variable: unknown): variable is T

  • 判断变量是否非空, 即变量不为 undefined 和 null

    Type parameters

    • T

    Parameters

    • variable: unknown

    Returns variable is T

parse

  • parse(str: string): ParseredURL

  • 解析URL

    Parameters

    • str: string

    Returns ParseredURL

parseToServerInfo

parseUserId

  • parseUserId(uri: string): string

  • Parameters

    • uri: string

    Returns string

randomNumber

  • randomNumber(t: number): number

  • Parameters

    • t: number

    Returns number

randomString

  • randomString(length: number, charset?: string): string

  • 生成随机字符串

    Parameters

    • length: number

      字符串长度

    • Optional charset: string

      字符串所使用的字符集, 默认使用 {@link Charset.UPPERCASE} + {@link Charset.LOWERCASE} + {@link Charset.NUMBER}

    Returns string

sizeOf

  • sizeOf(str: string): number

  • Parameters

    • str: string

    Returns number

stateMachineTranslation

  • stateMachineTranslation<T>(from: string[], to: string): (target: unknown, propertyKey: string, descriptor: PropertyDescriptor) => void

  • Type parameters

    Parameters

    • from: string[]
    • to: string

    Returns (target: unknown, propertyKey: string, descriptor: PropertyDescriptor) => void

      • (target: unknown, propertyKey: string, descriptor: PropertyDescriptor): void

      • Parameters

        • target: unknown
        • propertyKey: string
        • descriptor: PropertyDescriptor

        Returns void

throttle

  • throttle(func: (...args: unknown[]) => unknown, interval?: number): (...args: unknown[]) => unknown

  • Parameters

    • func: (...args: unknown[]) => unknown
        • (...args: unknown[]): unknown

        • Parameters

          • Rest ...args: unknown[]

          Returns unknown

    • Optional interval: number

    Returns (...args: unknown[]) => unknown

      • (...args: unknown[]): unknown

      • Parameters

        • Rest ...args: unknown[]

        Returns unknown

timeString

  • timeString(): string

  • Returns string

typeIs

  • typeIs(variable: unknown, ...typeArray: TYPE[]): boolean

  • 判断变量是否为typeArray中的某一个类型

    Parameters

    • variable: unknown

      待判断的变量

    • Rest ...typeArray: TYPE[]

      预选类型

    Returns boolean

    • variable的类型存在与typeArray中返回true，不存在返回false

typeIsArray

  • typeIsArray(variable: unknown): variable is unknown[]

  • Parameters

    • variable: unknown

    Returns variable is unknown[]

typeIsBoolean

  • typeIsBoolean(variable: unknown): variable is boolean

  • 判断变量类型是否为布尔类型

    Parameters

    • variable: unknown

    Returns variable is boolean

typeIsDate

  • typeIsDate(variable: unknown, isValid?: boolean): variable is Date

  • Parameters

    • variable: unknown
    • Optional isValid: boolean

    Returns variable is Date

typeIsFalse

  • typeIsFalse(variable: unknown): variable is boolean

  • Parameters

    • variable: unknown

    Returns variable is boolean

typeIsFunction

  • typeIsFunction(variable: unknown): variable is (...args: unknown[]) => unknown

  • 判断变量类型是否为{@link function}

    Parameters

    • variable: unknown

    Returns variable is (...args: unknown[]) => unknown

typeIsMediaStream

  • typeIsMediaStream(variable: unknown): variable is MediaStream

  • Parameters

    • variable: unknown

    Returns variable is MediaStream

typeIsMediaStreamTrack

  • typeIsMediaStreamTrack(variable: unknown): variable is MediaStreamTrack

  • Parameters

    • variable: unknown

    Returns variable is MediaStreamTrack

typeIsNumber

  • typeIsNumber(variable: unknown, notNaN?: boolean): variable is number

  • 判断变量类型是否为{@link number}

    Parameters

    • variable: unknown
    • Optional notNaN: boolean

    Returns variable is number

typeIsObject

  • typeIsObject(variable: unknown): variable is Record<string | number, unknown>

  • Parameters

    • variable: unknown

    Returns variable is Record<string | number, unknown>

typeIsPrimitives

  • typeIsPrimitives(variable: unknown): variable is Primitives

  • Parameters

    • variable: unknown

    Returns variable is Primitives

typeIsPromise

  • typeIsPromise(variable: unknown): variable is Promise<unknown>

  • Parameters

    • variable: unknown

    Returns variable is Promise<unknown>

typeIsString

  • typeIsString(variable: unknown, notNull?: boolean): variable is string

  • 判断变量类型是否为{@link string}

    Parameters

    • variable: unknown
    • Optional notNull: boolean

    Returns variable is string

typeIsThrow

  • typeIsThrow(variable: unknown, ...typeArray: TYPE[]): boolean

  • Parameters

    • variable: unknown
    • Rest ...typeArray: TYPE[]

    Returns boolean

typeIsThrowMulti

  • typeIsThrowMulti(variableParameterArr: [unknown, ...TYPE[]][]): { accept: boolean; error: Error }

  • Parameters

    • variableParameterArr: [unknown, ...TYPE[]][]

    Returns { accept: boolean; error: Error }

    • accept: boolean
    • error: Error

typeIsTrue

  • typeIsTrue(variable: unknown): variable is boolean

  • 判断变量类型是否为 true

    Parameters

    • variable: unknown

    Returns variable is boolean

typeOf

  • typeOf(variable: unknown): TYPE | string

  • 返回变量的类型

    Parameters

    • variable: unknown

    Returns TYPE | string

validAccountName

  • validAccountName(str: string): boolean

  • Parameters

    • str: string

    Returns boolean

validConferenceDeliveryOptions

validConferenceJoinParam

validConferenceNumber

  • validConferenceNumber(str: string): boolean

  • Parameters

    • str: string

    Returns boolean

validConferencePassword

  • validConferencePassword(str: string): boolean

  • Parameters

    • str: string

    Returns boolean

validGuestCallParam

Generated using TypeDoc