Class TCIC_IMAlpha

constructor

• new TCIC_IM(mainItem): TCIC_IM

• 传入TCIC实例

  Parameters

  • mainItem: TCIC

  Returns TCIC_IM

Readonly EVENT

Readonly TYPES

tim

isReady

• get isReady(): boolean

• Returns boolean

• set isReady(val): void

• Parameters

  • val: boolean

  Returns void

changeUser

• changeUser(tcic): Promise<any>

• 切换登陆用户

  Parameters

  • tcic: TCIC

    TCIC实例，以切换用户

  Returns Promise<any>

consume

• consume(eventName, param): void

• 消费掉所有准备的事件函数

  Parameters

  • eventName: keyof MsgTypeMap

    事件名

  • param: any

  Returns void

destroy

• destroy(): void

• Returns void

getHistoryList

• getHistoryList(): Promise<null | MsgData[]>

• 获取历史消息

  Returns Promise<null | MsgData[]>

login

• login(): Promise<any>

• Returns Promise<any>

off

• off(eventName, cb?): void

• 取消监听,不传callback则取消所有监听

  Parameters

  • eventName: keyof MsgTypeMap

    事件名

  • Optional cb: any

    回调

  Returns void

on

• on(eventName, cb): void

• 监听新的消息

  Parameters

  • eventName: keyof MsgTypeMap

  • cb: any

  Returns void

sendImgToUser

• sendImgToUser(file, opts): void

• 业务上暂时只支持文字图片二选一 如果后面支持，补充参数到sendMsgToUser即可

  Parameters

  • file: File

    图片

  • opts: {
        customData: any;
        userId: string;
    }

    可选参数,指定用户一对一发言，或者发送自定义消息

    • customData: any

    • userId: string

  Returns void

sendMsg

• sendMsg(payload, opts): void

• Parameters

  • payload: any

  • opts: {
        customData?: any;
        isCustomMsg?: boolean;
        isImage?: boolean;
        isRoom?: boolean;
        params?: any;
        userId?: string;
    }

    • Optional customData?: any

    • Optional isCustomMsg?: boolean

    • Optional isImage?: boolean

    • Optional isRoom?: boolean

    • Optional params?: any

    • Optional userId?: string

  Returns void

sendMsgToUser

• sendMsgToUser(text, opts): void

• 业务上暂时只支持文字图片二选一 如果后面支持，可以补充参数到opts上

  Parameters

  • text: string

    文字

  • opts: {
        customData: any;
        userId: string;
    }

    可选参数,指定用户一对一发言，或者发送自定义消息

    • customData: any

    • userId: string

  Returns void

sendRoomCustomMsg

• sendRoomCustomMsg(payload): void

• 发送自定义消息

  Parameters

  • payload: {
        data: any;
        extension: string;
    }

    msgPayload

    • data: any

    • extension: string

  Returns void

sendRoomImgMsg

• sendRoomImgMsg(file, opts?): void

• 发送图片消息

  Parameters

  • file: File

    fileInput对象

  • Optional opts: {
        customData: any;
        params: any;
    }

    可选参数

    • customData: any

    • params: any

  Returns void

sendRoomMsg

• sendRoomMsg(text, opts?): void

• 业务上暂时只支持文字图片二选一 调试用，客户统一调用后台以指定角色身份发言接口进行发言 如果后面支持，可以补充参数到opts上

  Parameters

  • text: string

  • Optional opts: {
        customData: any;
        params: any;
    }

    • customData: any

    • params: any

  Returns void

updateMyProfile

• updateMyProfile(option): void

• updateMyProfile

  Parameters

  • option: UPDATE_YOUR_PROFILE_OPTIONS

  Returns void

whenReady

• whenReady(cb): void

• 准备事件，用户进入房间后会触发

  Parameters

  • cb: ((arg) => void)

    回调

    • • (arg): void

      • Parameters

        • arg: TCIC_IM

        Returns void

  Returns void