Global

Members

(constant) AuthEvent :string

Properties:
Name Type Description
InvalidToken string

令牌作废。

授权模块的事件名称枚举。

Type:
  • string

(constant) CallEvent

See:

通话事件。

(constant) CallState

See:

通话状态。

(constant) CommEvent

See:

通讯事件。

(constant) CommFieldEndpointState :number

Properties:
Name Type Description
Normal number

正常状态。
Calling number

正在建立通话。
Busy number

当前线路忙。
CallConnected number

通话已接通。
CallBye number

通话结束。
Unknown number

未知的状态。

通信域节点状态码。

Type:
  • number

(constant) ConferenceAction

会议模块相关的指令动作。

(constant) ConferenceEvent

会议事件。

(constant) ConferenceServiceState

会议服务状态。

(constant) ContactEvent :string

Properties:
Name Type Description
SignIn string

当前客户端的联系人签入。
SignOut string

当前客户端的联系人签出。
Comeback string

当前客户端的联系人恢复连接。
GroupUpdated string

群组已更新。
GroupCreated string

群组被创建。
GroupDismissed string

群组已解散。
GroupMemberAdded string

群成员加入。
GroupMemberRemoved string

群成员移除。
GroupAppendixUpdated string

群组的附录进行了实时更新。
Fault string

遇到程序故障。
Unknown string

未知事件。

联系人模块的事件名称枚举。

Type:
  • string

(constant) ContactServiceState :number

Properties:
Name Type Description
Ok number

成功。
InvalidParameter number

无效的参数。
DataStructureError number

数据结构错误。
Failure number

遇到故障。
InvalidDomain number

无效域信息。
NoSignIn number

未签入联系人。
NotFindContact number

未找到联系人。
NotFindGroup number

未找到群组。
NotFindContactZone number

未找到联系人分区。
InconsistentToken number

令牌不一致。
IllegalOperation number

不被接受的非法操作。
ServerError number

服务器错误。
NotAllowed number

不被允许的操作。
NoNetwork number

无网络连接。
Unknown number

未知的状态。

联系人服务状态码。

Type:
  • number

(constant) ContactZoneParticipantState :number

Properties:
Name Type Description
Normal number

正常状态。
Pending number

待处理状态。
KnownPending number

已知待处理状态。
Reject number

拒绝。

分区参与人状态。

Type:
  • number

(constant) ContactZoneParticipantType :number

Properties:
Name Type Description
Contact number

联系人。
Group number

群组。
Organization number

组织或企业。
System number

系统。
Conference number

会议。
Other number

其他类型。

分区参与人类型。

Type:
  • number

(constant) ConversationReminding :number

Properties:
Name Type Description
Normal number

正常接收。
Closed number

接收不提醒。
NotCare number

接收但不关注。
Refused number

不接收。
toString number

解释提醒代码。

会话提醒类型。

Type:
  • number

(constant) ConversationState :number

Properties:
Name Type Description
Normal number

正常状态。
Important number

重要的或置顶的状态。
Deleted number

已删除状态。
Destroyed number

已销毁状态。
toString number

解释状态码。

会话状态。

Type:
  • number

(constant) ConversationType :number

Properties:
Name Type Description
Contact number

与联系人的会话。
Group number

与群组的会话。
Organization number

与组织的会话。
System number

系统类型会话。
Notifier number

通知类型会话。
Assistant number

助手类型会话。
Other number

其他会话类型。
toString number

转字符串形式的描述。

会话类型。

Type:
  • number

(constant) CubeMessagingServiceState

消息服务状态描述。

(constant) CubeNetworkEventName :string

Properties:
Name Type Description
connected string

与服务器建立连接。
disconnected string

与服务器断开连接。
failed string

连接时发生故障，建立连接失败。

网络事件名枚举。

Type:
  • string

(constant) CubeSignalAction

(constant) FaceMonitorEvent

脸部监视器事件。

(constant) FaceMonitorState

脸部监视器模块的状态定义。

(constant) FileProcessorAction

文件处理模块的动作定义。

(constant) FileProcessorState

文件处理服务状态描述。

(constant) FileStorageAction

文件存储动作。

(constant) FileStorageEvent

文件存储模块事件。

(constant) FileStorageState

文件存储模块状态。

(constant) GroupState :number

Properties:
Name Type Description
Normal number

正常状态。
Dismissed number

解散状态。
Forbidden number

禁用状态。
HighRisk number

高风险状态。
Disabled number

失效状态。
Unknown number

未知状态。

群组状态。

Type:
  • number

(constant) MessageState

Properties:
Name Type Description
Unknown number

未知。
Unsent number

未发送。
Sending number

发送中。
Sent number

已发送。
Read number

已读。
Recalled number

已召回。
Deleted number

已删除。
SendBlocked number

被阻止发送。
ReceiveBlocked number

被阻止接收。
Fault number

消息出现故障。

消息状态描述。

(constant) MessagingEvent :string

Properties:
Name Type Description
Ready string

当消息模块就绪时。
Notify string

收到新消息。
Sent string

消息已经发出。
Sending string

消息正在发送。
Processing string

消息数据处理中。
Recall string

消息被撤回。
Delete string

消息被删除。
Read string

消息已读。
MarkOnlyOwner string

消息被发送到服务器成功标记为仅作用于自己设备。
SendBlocked string

消息被阻止发送。
ReceiveBlocked string

消息被阻止接收。
ConversationUpdated string

会话数据被更新。
RemoteConversationsCompleted string

与服务器完成会话同步。
Fault string

消息处理故障。
Unknown string

未知事件。仅用于调试。

消息模块的事件枚举。

Type:
  • string

(constant) MultipointCommEvent :string

Properties:
Name Type Description
NewCall string

有新的通话邀请。 事件数据：CallRecord - 通话记录实例。
InProgress string

正在处理通话请求。 事件数据：CallRecord - 发起或应答通话的记录。
Ringing string

对方振铃。 事件数据：CallRecord - 通话记录实例。
Connected string

已经建立连接。 事件数据：CallRecord - 通话记录实例。
Busy string

对方忙。 事件数据：CallRecord - 通话记录实例。
Bye string

结束当前通话。 事件数据：CallRecord - 通话记录实例。
Invite string

发起邀请加入通话。 事件数据：CommField - 发出邀请的通讯场域的实例。 事件附加数据：Array - 被邀请人的 ID 清单。
Invited string

被邀请加入通话。 事件数据：CommField - 发出邀请的通讯场域的实例。 事件附加数据：Contact - 邀请人。
Arrived string

新参与者加入。 事件数据：CommFieldEndpoint - 已加入终端的实例。
Left string

参与者已离开。 事件数据：CommFieldEndpoint - 已离开终端的实例。
Followed string

已经接收参与者数据。 事件数据：CommFieldEndpoint - 终端的实例。
Unfollowed string

已经停止接收参与者数据。 事件数据：CommFieldEndpoint - 终端的实例。
Timeout string

呼叫或应答超时。 事件数据：CallRecord - 通话记录实例。
MediaConnected string

媒体流建立连接。 事件数据：CallRecord - 通话记录实例。
MediaDisconnected string

媒体流断开连接。 事件数据：CallRecord - 通话记录实例。
MicrophoneVolume string

麦克风音量事件。 事件数据：{ "endpoint": endpoint, "volume": volume: "timestamp": timestamp } 。
AudioMuted string
VideoMuted string
Failed string

发生错误。 事件数据：ModuleError 。
CallFailed string

呼叫发生错误。

多方通讯事件枚举。

Type:
  • string

(constant) MultipointCommState

Properties:
Name Type Description
Ok number

成功。
Failure number

遇到故障。
InvalidDomain number

无效域信息。
NoDomain number

没有域信息。
NoDevice number

没有设备信息。
NoContact number

没有找到联系人。
NoCommField number

没有找到通讯场域。
NoMediaUnit number

没有找到媒体单元。
NoPipeline number

没有找到与媒体单元的数据通道。
NoCommFieldEndpoint number

没有找到 Endpoint 。
NoPeerEndpoint number

没有找到对端。
DataStructureError number

数据结构错误。
CommFieldStateError number

场域状态错误。
MediaUnitField number

媒体单元故障。
UnsupportedSignaling number

不被支持的信令。
UnsupportedOperation number

不支持的操作。
CallerBusy number

主叫忙。
CalleeBusy number

被叫忙。
BeCallerBlocked number

被主叫阻止。
BeCalleeBlocked number

被被叫阻止。
Uninitialized number

终端未初始化。
ConnRepeated number

重复创建连接。
MediaPermissionDenied number

拒绝访问媒体设备。
NoVideoElement number

没有找到视频元素。
VideoElementNotSetting number

视频元素未设置。
InvalidCallRecord number

无效的通话记录实例。
SignalingError number

信令错误。
RTCPeerError number

RTC 节点数据不正确。
CreateOfferFailed number

创建 RTC offer SDP 错误。
CreateAnswerFailed number

创建 RTC answer SDP 错误。
LocalDescriptionFault number

设置本地 SDP 错误。
RemoteDescriptionFault number

设置远端 SDP 错误。
GroupStateError number

群组状态错误。
ServerFault number

服务器故障。

多方通信模块状态描述。

(constant) SignalEvent :string

信号传输模块事件。

Type:
  • string

(constant) StringUtil

字符串适用函数库。

(constant) ToolType

工具类型。

(constant) VideoDimension

视频画面尺寸描述。

(constant) WorkflowEvent :string

Properties:
Name Type Description
WorkflowStarted string

工作流已开始执行。
WorkflowStopped string

工作流已停止执行。
WorkBegun string

操作工作已开始。
WorkEnded string

操作工作已结束。

工作流事件。

Type:
  • string

Type Definitions

(object)

Properties:
Name Type Description
duration number

指定有效时长，单位：毫秒。设置 0 表示永久有效。
password string

指定提取文件时的密码。设置 null 值表示无需提取码。
preview boolean

指定是否为文档生成预览。
watermark string

指定水印内容。
download boolean

指定是否允许下载原始文件。
traceDownload boolean

指定是否跟踪下载操作。

文件分享标签配置。

ContactContextProviderCallback(contact, provider)

联系人上下文数据回调。

Parameters:
Name Type Description
contact Contact

需要获取上下文的联系人实例。
provider ContactContextProvider

数据提供器。

ContactSearchResult

Properties:
Name Type Description
keyword string

检索的关键词。
contactList Array

联系人列表。
groupList Array

群组列表。

搜索结果定义。

Type:
  • object

CubeNetworkCallback(event)

事件回调函数。

Parameters:
Name Type Description
event CubeNetworkEvent

网络事件。

CubeNetworkEvent

Properties:
Name Type Description
name string

事件名。
pipeline Pipeline

发生事件的数据管道。
error PipelineError

故障事件的错误描述。

网络事件定义。

Type:
  • object

FormattedContent

Properties:
Name Type Description
format string

内容的格式：text，at，emoji 。
content object | string

内容。

格式化的内容。

Type:
  • object

KernelConfig

Properties:
Name Type Attributes Description
address string

管道服务器地址。
domain string

授权的指定域。
appKey string

当前应用申请到的 App Key 串。
unconnected boolean <optional>

启动时不进行连接。
pipelineReady boolean <optional>

内核是否等待通道就绪再回调。
port number <optional>

WebSocket 端口。
securePort number <optional>

Secure WebSocket 端口。
log number <optional>

日志等级。

内核配置定义。

Type:
  • object

ModuleEvent

Properties:
Name Type Description
name string

事件名称。
data object

事件关联的数据。

模块事件。

Type:
  • object

ResponseCallback(pipeline, source, packet)

收到指定的数据包的应答回调。

Parameters:
Name Type Description
pipeline Pipeline

接收到数据的通道。
source string

服务端访问描述。
packet Packet

来自服务器的返回数据包。

RestoreResult

Properties:
Name Type Description
successList Array.<Trash>

成功恢复的数据列表。
failureList Array.<Trash>

未能成功恢复的数据列表。

文件恢复结果描述。

Type:
  • object

SearchFilter

Properties:
Name Type Attributes Description
begin number

检索的起始索引。
end number

检索的结束索引。
types Array <optional>

包含检索的文件类型。
nameKeywords Array <optional>

包含检索的名称关键词。
inverseOrder boolean <optional>

是否安排时间倒序返回结果。

搜索过滤器定义。

Type:
  • object

UploadCallback(anchor)

上传文件回调函数。

Parameters:
Name Type Description
anchor FileAnchor

文件定位点。