dingtalk-web-meeting-sdk

核心类参考 index/MeetingService

@ali/dingtalk-web-meeting-sdk

dingtalk-web-meeting-sdk

dingtalk-web-meeting-sdk

Modules

核心类参考 index/MeetingService

• index
• types

Enumerations

ApiName

用于sdk内部与 iframe 之间RPC调用，业务不感知

Enumeration Members

changeMyName

changeMyName: "changeMyName"

commitLog

commitLog: "commitLog"

invokeClient

invokeClient: "invokeClient"

joinConf

joinConf: "joinConf"

leaveConf

leaveConf: "leaveConf"

muteCam

muteCam: "muteCam"

muteMic

muteMic: "muteMic"

pauseMinute

pauseMinute: "pauseMinute"

playAudio

playAudio: "playAudio"

restartMinute

restartMinute: "restartMinute"

sendMsg

sendMsg: "sendMsg"

smallWindowMode

smallWindowMode: "smallWindowMode"

startMinute

startMinute: "startMinute"

unmuteCam

unmuteCam: "unmuteCam"

unmuteMic

unmuteMic: "unmuteMic"

EConfigNames

Enumeration Members

auto_invoke_client

auto_invoke_client: 19

autostart_flash_minutes

autostart_flash_minutes: 21

autostart_subtitle

autostart_subtitle: 22

biz

biz: 18

cam_status

cam_status: 26

click_full_screen

click_full_screen: 24

conf_info_btn

conf_info_btn: 10

end_btn

end_btn: 1

feedback_btn

feedback_btn: 15

footer

footer: 0

force_immersed_mode

force_immersed_mode: 8

free

free: 20

full_screen

full_screen: 2

hide_main_view_status

hide_main_view_status: 12

hide_small_window_bar

hide_small_window_bar: 7

hide_top_part

hide_top_part: 11

invite

invite: 3

lang

lang: 27

leave_btn

leave_btn: 6

member_list

member_list: 4

mic_status

mic_status: 25

record_audio

record_audio: 23

screen_share

screen_share: 5

settings_btn

settings_btn: 14

small_window

small_window: 9

subtitle_ui

subtitle_ui: 13

visitor

visitor: 17

window_minsize_limit

window_minsize_limit: 16

EMeetingSdkPublicEvent

Enumeration Members

abortedByDupTabCheck

abortedByDupTabCheck: "abortedByDupTabCheck"

页面被重复的标签页面停止

audioAutoPlayFailed

audioAutoPlayFailed: "audioAutoPlayFailed"

hangup

hangup: "hangup"

loginByOtherDevice

loginByOtherDevice: "loginByOtherDevice"

meetingEnd

meetingEnd: "meetingEnd"

subTitle

subTitle: "subTitle"

EMsgType

Enumeration Members

notify

notify: "notify"

meeting 推送的通知类型

request

request: "request"

sdk层对meeting的请求

response

response: "response"

meeting响应sdk层对meeting的请求

ESdkInnerEventName

Enumeration Members

join_result

join_result: "join_result"

sdk_ready

sdk_ready: "sdk_ready"

ESdkJoinFailReason

Enumeration Members

login_fail_with_auth_info

login_fail_with_auth_info: "login_fail_with_auth_info"

not_allow_web_join

not_allow_web_join: "not_allow_web_join"

Classes

MeetingService

Extends

• EventEmitter2

Constructors

new MeetingService()

new MeetingService(): MeetingService

Returns

MeetingService

Overrides

EventEmitter2.constructor

Properties

defaultMaxListeners

static defaultMaxListeners: number

Inherited from

EventEmitter2.defaultMaxListeners

Methods

addListener()

addListener(event, listener): MeetingService | Listener

Parameters

event

string | symbol | event[]

listener

ListenerFn

Returns

MeetingService | Listener

Inherited from

EventEmitter2.addListener

changeMyName()

changeMyName(newName): Promise<any>

Parameters

newName

string

Returns

Promise<any>

destroy()

destroy(): Promise<void>

销毁本实例的相关资源，本实例不可继续使用

Returns

Promise<void>

emit()

emit(event, ...values): boolean

Parameters

event

string | symbol | event[]

values

...any[]

Returns

boolean

Inherited from

EventEmitter2.emit

emitAsync()

emitAsync(event, ...values): Promise<any[]>

Parameters

event

string | symbol | event[]

values

...any[]

Returns

Promise<any[]>

Inherited from

EventEmitter2.emitAsync

eventNames()

eventNames(nsAsArray?): (string | symbol | event[])[]

Parameters

nsAsArray?

boolean

Returns

(string | symbol | event[])[]

Inherited from

EventEmitter2.eventNames

getMaxListeners()

getMaxListeners(): number

Returns

number

Inherited from

EventEmitter2.getMaxListeners

getSdkVersion()

getSdkVersion(): string

Returns

string

hasListeners()

hasListeners(event?): Boolean

Parameters

event?

String

Returns

Boolean

Inherited from

EventEmitter2.hasListeners

invokeNativeClient()

invokeNativeClient(): void

Returns

void

joinConf()

joinConf(authParam, mountPoint, config): Promise<boolean>

join 如果是加载预览页面，则在用户点击join按钮之后返回join结果。 如果直接打开会议页面，则无需用户参与，自动执行join过程。成功后会议UI会加载到目标元素中

Parameters

authParam

ISsoAuthParam | IAnonyAuthParam

mountPoint

HTMLElement

config

IConfig

Returns

Promise<boolean>

leaveConf()

leaveConf(): Promise<unknown>

Returns

Promise<unknown>

listenerCount()

listenerCount(event?): number

Parameters

event?

string | symbol | event[]

Returns

number

Inherited from

EventEmitter2.listenerCount

listeners()

listeners(event?): ListenerFn[]

Parameters

event?

string | symbol | event[]

Returns

ListenerFn[]

Inherited from

EventEmitter2.listeners

listenersAny()

listenersAny(): ListenerFn[]

Returns

ListenerFn[]

Inherited from

EventEmitter2.listenersAny

listenTo()

Call Signature

listenTo(target, events, options?): this

Parameters

target

GeneralEventEmitter

events

string | symbol | event[]

options?

ListenToOptions

Returns

this

Inherited from

EventEmitter2.listenTo

Call Signature

listenTo(target, events, options?): this

Parameters

target

GeneralEventEmitter

events

event[]

options?

ListenToOptions

Returns

this

Inherited from

EventEmitter2.listenTo

Call Signature

listenTo(target, events, options?): this

Parameters

target

GeneralEventEmitter

events

Object

options?

ListenToOptions

Returns

this

Inherited from

EventEmitter2.listenTo

many()

many(event, timesToListen, listener, options?): MeetingService | Listener

Parameters

event

string | symbol | event[]

timesToListen

number

listener

ListenerFn

options?

boolean | OnOptions

Returns

MeetingService | Listener

Inherited from

EventEmitter2.many

muteCam()

muteCam(): Promise<any>

Returns

Promise<any>

muteMic()

muteMic(): Promise<any>

Returns

Promise<any>

off()

off(event, listener): this

Parameters

event

string | symbol | event[]

listener

ListenerFn

Returns

this

Inherited from

EventEmitter2.off

offAny()

offAny(listener): this

Parameters

listener

ListenerFn

Returns

this

Inherited from

EventEmitter2.offAny

on()

on(event, listener, options?): MeetingService | Listener

Parameters

event

string | symbol | event[]

listener

ListenerFn

options?

boolean | OnOptions

Returns

MeetingService | Listener

Inherited from

EventEmitter2.on

onAny()

onAny(listener): this

Parameters

listener

EventAndListener

Returns

this

Inherited from

EventEmitter2.onAny

once()

once(event, listener, options?): MeetingService | Listener

Parameters

event

string | symbol | event[]

listener

ListenerFn

options?

true | OnOptions

Returns

MeetingService | Listener

Inherited from

EventEmitter2.once

~~pauseMinute()~~

pauseMinute(recordAudio): Promise<any>

Parameters

recordAudio

boolean

Returns

Promise<any>

Deprecated

~~playAudio()~~

playAudio(): Promise<any>

Returns

Promise<any>

Deprecated

该接口目前没有啥用

prependAny()

prependAny(listener): this

Parameters

listener

EventAndListener

Returns

this

Inherited from

EventEmitter2.prependAny

prependListener()

prependListener(event, listener, options?): MeetingService | Listener

Parameters

event

string | symbol | event[]

listener

ListenerFn

options?

boolean | OnOptions

Returns

MeetingService | Listener

Inherited from

EventEmitter2.prependListener

prependMany()

prependMany(event, timesToListen, listener, options?): MeetingService | Listener

Parameters

event

string | symbol | event[]

timesToListen

number

listener

ListenerFn

options?

boolean | OnOptions

Returns

MeetingService | Listener

Inherited from

EventEmitter2.prependMany

prependOnceListener()

prependOnceListener(event, listener, options?): MeetingService | Listener

Parameters

event

string | symbol | event[]

listener

ListenerFn

options?

boolean | OnOptions

Returns

MeetingService | Listener

Inherited from

EventEmitter2.prependOnceListener

removeAllListeners()

removeAllListeners(event?): this

Parameters

event?

string | symbol | event[]

Returns

this

Inherited from

EventEmitter2.removeAllListeners

removeListener()

removeListener(event, listener): this

Parameters

event

string | symbol | event[]

listener

ListenerFn

Returns

this

Inherited from

EventEmitter2.removeListener

~~restartMinute()~~

restartMinute(): Promise<any>

Returns

Promise<any>

Deprecated

~~setCameraStatus()~~

setCameraStatus(status): Promise<any>

Parameters

status

boolean

Returns

Promise<any>

Deprecated

函数名不规范

setMaxListeners()

setMaxListeners(n): void

Parameters

n

number

Returns

void

Inherited from

EventEmitter2.setMaxListeners

~~setMicStatus()~~

setMicStatus(status): Promise<any>

Parameters

status

boolean

Returns

Promise<any>

Deprecated

函数名不规范

setSmallWindowMode()

setSmallWindowMode(isEnter): Promise<any>

Parameters

isEnter

boolean

Returns

Promise<any>

startMinute()

startMinute(): Promise<any>

Returns

Promise<any>

stopListeningTo()

stopListeningTo(target?, event?): Boolean

Parameters

target?

GeneralEventEmitter

event?

string | symbol | event[]

Returns

Boolean

Inherited from

EventEmitter2.stopListeningTo

unmuteCam()

unmuteCam(): Promise<any>

Returns

Promise<any>

unmuteMic()

unmuteMic(): Promise<any>

Returns

Promise<any>

waitFor()

Call Signature

waitFor(event, timeout?): CancelablePromise<any[]>

Parameters

event

string | symbol | event[]

timeout?

number

Returns

CancelablePromise<any[]>

Inherited from

EventEmitter2.waitFor

Call Signature

waitFor(event, filter?): CancelablePromise<any[]>

Parameters

event

string | symbol | event[]

filter?

WaitForFilter

Returns

CancelablePromise<any[]>

Inherited from

EventEmitter2.waitFor

Call Signature

waitFor(event, options?): CancelablePromise<any[]>

Parameters

event

string | symbol | event[]

options?

WaitForOptions

Returns

CancelablePromise<any[]>

Inherited from

EventEmitter2.waitFor

once()

static once(emitter, event, options?): CancelablePromise<any[]>

Parameters

emitter

EventEmitter2

event

string | symbol | event[]

options?

OnceOptions

Returns

CancelablePromise<any[]>

Inherited from

EventEmitter2.once

Interfaces

IAnonyAuthParam

Properties

appId

appId: string

appUid

appUid: string

nick

nick: string

sdkToken

sdkToken: string

IAuthInfo

Properties

accessExpiredTime

accessExpiredTime: number

accessToken

accessToken: string

deviceId

deviceId: string

dingTalkUserId

dingTalkUserId: string

nick

nick: string

refreshExpiredTime

refreshExpiredTime: number

refreshToken

refreshToken: string

IConfig

Properties

auto_invoke_client?

optional auto_invoke_client: "0" | "1"

autostart_flash_minutes?

optional autostart_flash_minutes: "0" | "1"

autostart_subtitle?

optional autostart_subtitle: "0" | "1"

biz

biz: string

cam_status?

optional cam_status: "0" | "1"

click_full_screen?

optional click_full_screen: "0" | "1"

conf_info_btn?

optional conf_info_btn: "0" | "1"

end_btn?

optional end_btn: "0" | "1"

footer?

optional footer: "0" | "1"

free?

optional free: "0" | "1"

full_screen?

optional full_screen: "0" | "1"

hide_main_view_status?

optional hide_main_view_status: "0" | "1"

hide_small_window_bar?

optional hide_small_window_bar: "0" | "1"

initPage?

optional initPage: "RoomPage" | "JoinPage"

invite?

optional invite: "0" | "1"

lang?

optional lang: "en_US" | "zh_CN " | "zh_TW" | "ja_JP"

leave_btn?

optional leave_btn: "0" | "1"

linkId?

optional linkId: string

meetingBase?

optional meetingBase: string

member_list?

optional member_list: "0" | "1"

mic_status?

optional mic_status: "0" | "1"

nick?

optional nick: string

record_audio?

optional record_audio: "0" | "1"

screen_share?

optional screen_share: "0" | "1"

small_window?

optional small_window: "0" | "1"

subtitle_ui?

optional subtitle_ui: "0" | "1"

visitor?

optional visitor: "0" | "1"

window_minsize_limit?

optional window_minsize_limit: "0" | "1"

IJoinResult

Properties

error_code

error_code: string

error_message

error_message: string

success

success: boolean

IMeetingSdkMsg

Properties

msgBody

msgBody: IMsgBody

msgChannel

msgChannel: "dingtalk-meeting-sdk"

IMember

Properties

attendStatus

attendStatus: string

avatar

avatar: string

cameraStatus

cameraStatus: string

micStatus

micStatus: string

nick

nick: string

userId

userId: string

IMsgBody

Properties

error?

optional error: any

notifyArgs?

optional notifyArgs: any[]

notifyName?

optional notifyName: string

reqArgs?

optional reqArgs: any[]

reqId?

optional reqId: number

reqName?

optional reqName: string

result?

optional result: any

type

type: EMsgType

IReqResult<T>

Type Parameters

• T

Properties

data

data: T

errCode?

optional errCode: any

errMessage?

optional errMessage: any

success

success: boolean

ISsoAuthParam

Properties

appId

appId: string

idToken

idToken: string

sdkToken

sdkToken: string

SubtitleMessageModel

Properties

beginTime?

optional beginTime: number

endTime?

optional endTime: number

extension?

optional extension: string

hasShowed

hasShowed: boolean

lang?

optional lang: string

oldSubTitle?

optional oldSubTitle: string

reachTime?

optional reachTime: number

sentenceEnd?

optional sentenceEnd: boolean

sentenceId

sentenceId: number

seqId

seqId: number

subtitle

subtitle: string

uid

uid: number

unfixedResult?

optional unfixedResult: string

Variables

forward_event_out_to_meeting_service

const forward_event_out_to_meeting_service: "forward_event_out_to_meeting_service" = 'forward_event_out_to_meeting_service'

透传事件到meeting Service对象，用户代码只需要在meeting Service对象上监听事件即可

meeting_sdk_msg_channel

const meeting_sdk_msg_channel: "dingtalk-meeting-sdk" = 'dingtalk-meeting-sdk'

Functions

isBrowserSupported()

isBrowserSupported(): boolean

Returns

boolean