Interface JCommonManager<T, F>

公共模块管理接口 JCommonManager

Remarks

定义了菊风云通信服务的主要管理接口，提供登录、消息传输、文件上传等核心功能 通过泛型支持不同场景下的配置和回调扩展

interface JCommonManager<
    T extends JCCCommonCustomConfig,
    F extends JCommonCallback,
> {
    setForeground(foreground: boolean): void;
    setUIContext(uiContext: UIContext): void;
    setNavPathStack(pathStack: any, navId: undefined | string): void;
    login(
        applicationContext: ApplicationContext,
        loginParam: JCCLoginParam,
    ): boolean;
    logout(): boolean;
    destroy(): void;
    getClientLoginState(): JClientState;
    sendOnlineMessage(message: string, userId: string): number;
    sendMessageInCall(type: string, content: string, userId: string): boolean;
    uploadFile(param: JCCUploadFileParam): void;
    getCallId(): undefined | string;
    setCustomConfig(customConfig: T): void;
    setVideoAngle(angle: number): void;
    miniTalkingWindow(): void;
    restoreTalkingWindow(): void;
    getVersion(): JCCVersion;
    enableRemoteCollaboration(enable: boolean): boolean;
    getClient(): any;
    getMediaDevice(): any;
    addCallback(callback: F): void;
    removeCallback(callback: F): void;
}

Type Parameters

Methods

setForeground setUIContext setNavPathStack login logout destroy getClientLoginState sendOnlineMessage sendMessageInCall uploadFile getCallId setCustomConfig setVideoAngle miniTalkingWindow restoreTalkingWindow getVersion enableRemoteCollaboration getClient getMediaDevice addCallback removeCallback

Methods

setForeground

  • setForeground(foreground: boolean): void

    设置应用前后台状态

    Parameters

    • foreground: boolean

      是否是前台

    Returns void

    Remarks

    在访客场景下通知座席客户端前后台变化

    • true：设置为前台状态
    • false：设置为后台状态

setUIContext

  • setUIContext(uiContext: UIContext): void

    设置UI上下文对象

    Parameters

    • uiContext: UIContext

      UI上下文对象

    Returns void

    Remarks

    如果设置了，我们的通话界面会往该对象获取的 Router 对象中添加页面

setNavPathStack

  • setNavPathStack(pathStack: any, navId: undefined | string): void

    设置 NavPathStack 实例

    Parameters

    • pathStack: any

      NavPathStack实例

    • navId: undefined | string

      Navigation容器绑定的id

    Returns void

    Remarks

    如果设置了，我们的通话界面会通过这个实例去进行路由跳转

login

  • login(
        applicationContext: ApplicationContext,
        loginParam: JCCLoginParam,
    ): boolean

    登录系统

    Parameters

    • applicationContext: ApplicationContext

      应用上下文

    • loginParam: JCCLoginParam

      登录参数

    Returns boolean

    接口调用结果

    Remarks

    登录系统，启动通信服务 登录结果通过 JCommonCallback.onLogin 回调通知

    • 返回true表示接口调用成功，等待回调通知结果
    • 返回false表示接口调用失败，不会有回调通知

logout

  • logout(): boolean

    登出系统

    Returns boolean

    接口调用结果

    Remarks

    登出系统，停止通信服务 登出结果通过 JCommonCallback.onLogout 回调通知

    • 返回true表示接口调用成功，等待回调通知结果
    • 返回false表示接口调用失败，不会有回调通知

destroy

  • destroy(): void

    销毁实例

    Returns void

    Remarks

    销毁实例，释放资源并清理数据。

getClientLoginState

  • getClientLoginState(): JClientState

    获取当前登录状态

    Returns JClientState

    当前登录状态

    Remarks

    返回系统当前的登录状态

    See

    JClientState 可能的登录状态枚举

sendOnlineMessage

  • sendOnlineMessage(message: string, userId: string): number

    发送在线消息

    Parameters

    • message: string

      消息内容

    • userId: string

      接收消息的用户ID

    Returns number

    操作ID或错误码

    Remarks

    向指定用户发送即时消息 消息发送结果通过 JCommonCallback.onOnlineMessageSendResult 回调通知

    • 返回大于0的值表示操作ID，对应回调中的operatorId参数
    • 返回-1表示调用异常，不会收到回调通知

sendMessageInCall

  • sendMessageInCall(type: string, content: string, userId: string): boolean

    发送通话中消息

    Parameters

    • type: string

      消息类型

    • content: string

      消息内容

    • userId: string

      接收消息的用户ID，为空则发送给所有成员

    Returns boolean

    接口调用结果

    Remarks

    通过透明通道向通话中的成员发送消息

    • 消息内容不能大于4KB
    • 返回true表示接口调用成功
    • 返回false表示接口调用失败

uploadFile

  • uploadFile(param: JCCUploadFileParam): void

    上传文件

    Parameters

    • param: JCCUploadFileParam

      文件上传参数

    Returns void

    Remarks

    将文件上传到服务器

    Description

    上传结果通过 JCommonCallback.onUploadFileResult 或 JCommonCallback.onUploadFileError 回调通知

    See

    JCCUploadFileParam 文件上传参数配置

getCallId

  • getCallId(): undefined | string

    获取通话ID

    Returns undefined | string

    当前通话ID

    Remarks

    返回当前活跃通话的唯一标识符 可用于日志记录、问题排查或关联其他业务数据

setCustomConfig

  • setCustomConfig(customConfig: T): void

    设置定制配置参数

    Parameters

    • customConfig: T

      定制化配置参数

    Returns void

    Remarks

    设置系统的定制化配置，如UI样式、功能开关等 配置会立即生效，影响系统的行为和外观

setVideoAngle

  • setVideoAngle(angle: number): void

    设置视频旋转角度

    Parameters

    • angle: number

      视频旋转角度

    Returns void

    Remarks

    设置视频画面的旋转角度 可用于适配不同的屏幕方向或摄像头安装角度

    See

    JMediaDeviceVideoAngle 预定义的视频角度枚举

miniTalkingWindow

  • miniTalkingWindow(): void

    最小化通话窗口

    Returns void

    Remarks

    将当前通话窗口最小化显示 通常用于多任务场景，允许用户同时处理其他事务

restoreTalkingWindow

  • restoreTalkingWindow(): void

    恢复通话窗口

    Returns void

    Remarks

    将最小化的通话窗口恢复到正常大小 用于从最小化状态恢复通话窗口

getVersion

  • getVersion(): JCCVersion

    获取SDK和底层库的版本信息

    Returns JCCVersion

    SDK版本信息对象

    Remarks

    返回包含各组件版本号的信息对象 可用于兼容性检查、问题排查和日志记录

    See

    JCCVersion 版本信息类

enableRemoteCollaboration

  • enableRemoteCollaboration(enable: boolean): boolean

    开启/关闭远程协作

    Parameters

    • enable: boolean

      true: 开启

      • false: 关闭

    Returns boolean

    接口调用结果

    • true: 接口调用成功
    • false: 接口调用失败

getClient

  • getClient(): any

    获取JRTCClient实例

    Returns any

    JRTCClient实例

    Remarks

    获取JRTCClient实例，用于访问JRTCClient的API。

getMediaDevice

  • getMediaDevice(): any

    获取JRTCMediaDevice实例

    Returns any

    获取JRTCMediaDevice实例

    Remarks

    获取JRTCMediaDevice实例，用于访问JRTCMediaDevice的API。

addCallback

  • addCallback(callback: F): void

    订阅回调事件

    Parameters

    • callback: F

      回调对象

    Returns void

    Remarks

    添加一个事件回调监听器 添加后将接收系统的各类事件通知

removeCallback

  • removeCallback(callback: F): void

    取消订阅回调事件

    Parameters

    • callback: F

      回调对象

    Returns void

    Remarks

    移除之前添加的事件回调监听器 取消订阅后将不再接收系统事件通知

设置

主题