CubeShortcut

CubeShortcut

Cube Engine 的快捷操作方式封装。

Constructor

new CubeShortcut()

Classes

CubeShortcut

Members

auth :AuthService

授权服务模块。

Type:

conference :ConferenceService

会议模块。

Type:

contact :ContactService

联系人模块。

Type:

cs :ConferenceService

会议模块。

Type:

fileProcessor :FileProcessor

文件处理模块。

Type:

fileStorage :FileStorage

文件存储模块。

Type:

fp :FileProcessor

文件处理模块。

Type:

fs :FileStorage

文件存储模块。

Type:

messaging :MessagingService

消息模块。

Type:

mpComm :MultipointComm

多方通讯模块。

Type:

Methods

addLogHandler(handler)

添加日志监听器。

Parameters:
Name Type Description
handler LogHandler

日志监听器。

getModule(moduleName)

获取指定名称的模块。

Parameters:
Name Type Description
moduleName string

模块名。

isReady() → {boolean}

判断所有模块是否都准备就绪。

Returns:

如果已安装模块准备就绪返回 true

Type
boolean

launchFileSelector(handle, acceptopt)

启动文件选择器。

Parameters:
Name Type Attributes Description
handle function

文件选择回调函数。

accept string <optional>

input 标签的 accept 属性值。

on(event, listener)

设置事件监听器。

Parameters:
Name Type Description
event string

事件名。 支持的事件: 'network', 'pipeline'

listener CubeNetworkCallback

监听函数。

removeLogHandler(handler)

移除日志监听器。

Parameters:
Name Type Description
handler LogHandler

日志监听器。

signIn(id, nameopt, contextopt, deviceopt)

将当前终端指定的联系人签入。

Parameters:
Name Type Attributes Description
id number

联系人 ID 。

name string <optional>

联系人名称。

context JSON <optional>

联系人关联的上下文。

device Device <optional>

指定设备。

signOut() → {boolean}

将已签入的联系人签出。

Returns:

如果当前状态正常,允许签出返回 true

Type
boolean

start(config, handleSuccess, handleFailureopt)

启动 Cube 并与服务器建立连接。

Parameters:
Name Type Attributes Description
config KernelConfig

配置信息。

handleSuccess function

启动成功回调。

handleFailure function <optional>

启动失败回调。

stop()

关闭 Cube 并断开与服务器的连接。