Interface JCClientCallback

JCClientCallback 回调，用于回调登录相关事件

interface JCClientCallback {
    onClientStateChange?: ((state: number, oldState: number) => void);
    onLogin?: ((result: boolean, reason: number) => void);
    onLogout?: ((reason: number) => void);
    onOnlineMessageReceive?: ((userId: string, content: string) => void);
    onOnlineMessageSendResult?: ((operationId: number, result: boolean) => void);
    onServerMessageReceive?: ((type: string, params: string, message: string) => void);
}

Properties

onClientStateChange? onLogin? onLogout? onOnlineMessageReceive? onOnlineMessageSendResult? onServerMessageReceive?

Properties

OptionalonClientStateChange

onClientStateChange?: ((state: number, oldState: number) => void)

登录状态变化回调

在用户的登录状态发生改变时会收到此回调，登录状态：

Type declaration

    • (state, oldState): void

    • Parameters

      • state: number

        当前状态值

      • oldState: number

        之前状态值

      Returns void

OptionalonLogin

onLogin?: ((result: boolean, reason: number) => void)

登录结果回调

在调用 login 方法成功后会收到此回调

Type declaration

    • (result, reason): void

    • Parameters

      • result: boolean

        登录是否成功

        • true：登录成功
        • false：登录失败
      • reason: number

        登录失败原因，当 result 为 false 时该值有效。参见：ClientReason

      Returns void

OptionalonLogout

onLogout?: ((reason: number) => void)

登出回调

在调用 logout 方法成功后会收到此回调

Type declaration

    • (reason): void

    • Parameters

      Returns void

OptionalonOnlineMessageReceive

onOnlineMessageReceive?: ((userId: string, content: string) => void)

收到在线消息

Type declaration

    • (userId, content): void

    • Parameters

      • userId: string

        消息发送方用户标识

      • content: string

        消息内容

      Returns void

OptionalonOnlineMessageSendResult

onOnlineMessageSendResult?: ((operationId: number, result: boolean) => void)

在线消息发送结果

Type declaration

    • (operationId, result): void

    • Parameters

      • operationId: number

        操作id, 由 sendOnlineMessage 返回

      • result: boolean

        消息发送是否成功

      Returns void

OptionalonServerMessageReceive

onServerMessageReceive?: ((type: string, params: string, message: string) => void)

收到服务的消息

Type declaration

    • (type, params, message): void

    • Parameters

      • type: string

        订阅的消息类型

      • params: string

        配置信息

      • message: string

        消息内容

      Returns void

Settings

Member Visibility

On This Page

Properties