node-nim/types/nim_def/subscribe_event_def.d.ts

NetEase IM nodejs wrapper based on NetEase IM C++ SDK

import { NIMResCode } from './client_def';
/** @enum NIMEventBroadcastType 事件广播类型 */
export declare enum NIMEventBroadcastType {
    /** 仅在线 */
    kNIMEventBroadcastTypeOnline = 1,
    /** 在线和离线 */
    kNIMEventBroadcastTypeAll = 2
}
/** @enum NIMEventSyncType 事件同步类型 */
export declare enum NIMEventSyncType {
    /** 事件不同步给自己其他端 */
    kNIMEventSyncTypeNoSelf = 0,
    /** 事件同步给自己其他端 */
    kNIMEventSyncTypeSelf = 1
}
/** @enum NIMEventSubscribeSyncEventType 订阅的事件的同步类型 */
export declare enum NIMEventSubscribeSyncEventType {
    /** 订阅后不同步最新事件 */
    kNIMEventSubscribeSyncTypeUnSync = 0,
    /** 订阅后立即同步最新事件 */
    kNIMEventSubscribeSyncTypeSync = 1
}
/** @enum NIMEventType 服务器预定义的事件类型 */
export declare enum NIMEventType {
    /** 在线状态事件(客户端可发送) */
    kNIMEventTypeOnlineState = 1,
    /** 同步“订阅事件”事件(客户端不可发送) */
    kNIMEventTypeSyncEvent = 2,
    /** 服务器保留1～99999的事件类型，客户端自定义事件类型需大于99999 */
    kNIMEventTypeCustom = 100000
}
/** @enum NIMEventOnlineStateValue 在线状态事件值 */
export declare enum NIMEventOnlineStateValue {
    /** 登录 */
    kNIMEventOnlineStateValueLogin = 1,
    /** 登出 */
    kNIMEventOnlineStateValueLogout = 2,
    /** 断开连接 */
    kNIMEventOnlineStateValueDisconnect = 3,
    /** 在线状态事件服务器保留1～9999的事件值，客户端自定义事件值需大于9999 */
    kNIMEventOnlineStateValueCustom = 10000,
    /** 自己的其他端更新了自己端的multi_config信息 */
    kNIMEventOnlineStateValueUpdateConfig = 10001
}
export declare enum NIMOnlineState {
    /** 在线 */
    kOnlineStateOnline = 0,
    /** 忙碌 */
    kOnlineStateBusy = 1,
    /** 离开 */
    kOnlineStateLeave = 2
}
export declare enum NIMNetState {
    kNetStateUnknow = 0,
    kNetStateWifi = 1,
    kNetStateWwan = 2,
    kNetState2G = 3,
    kNetState3G = 4,
    kNetState4G = 5
}
export interface EventData {
    /** 事件类型，服务器保留1～99999的事件类型，客户端自定义事件类型需大于99999 */
    event_type_?: number;
    /** 事件状态，在线状态事件服务器保留1～9999的事件值，客户端自定义事件值需大于9999 */
    event_value_?: number;
    /** 客户端生成的消息id */
    client_msg_id_?: string;
    /** 用户自定义事件扩展属性，最长4K */
    config_?: string;
    /** 事件有效期，单位：秒，时间范围：60s到7天 */
    ttl_?: number;
    /** 事件广播类型 */
    broadcast_type_?: NIMEventBroadcastType;
    /** 事件同步类型 */
    sync_self_?: NIMEventSyncType;
    /** TtlType枚举值 */
    readonly_ttl_type?: number;
    /** 是否需要持久化(可选字段)，默认为需要持久化,0:不需要持久化，1：需要持久化 */
    readonly_durable_?: number;
    /** 事件发布的时间戳，服务器补充 */
    readonly_event_time_?: number;
    /** 服务端生成的消息id */
    readonly_server_msg_id_?: string;
    /** 发送客户端类型 */
    readonly_client_type_?: number;
    /** 预定义事件的扩展字段（在线状态事件：在线的客户端类型Json） */
    readonly_nim_config_?: string;
    /** 多端配置信息字段，JSON格式{"clent_type":"clent_config","1":"xxx","2":"xxx"} */
    readonly_multi_config_?: string;
    /** 事件发布者的accid */
    readonly_publisher_accid_?: string;
    /** 发送设备id */
    readonly_consid_?: string;
}
export interface EventSubscribeData {
    /** 事件类型 */
    event_type_?: number;
    /** 订阅有效期，单位：秒，范围：60s到30天 */
    ttl_?: number;
    /** 订阅的事件的同步类型 */
    sync_event_?: NIMEventSubscribeSyncEventType;
    /** 被订阅人（事件发布人）的accid */
    publisher_accid_?: string;
    /** 订阅人的accid */
    subscribe_accid_?: string;
    /** 订阅时间戳 */
    subscribe_time_?: number;
}
export type PushEventCallback = (rescode: NIMResCode, result: EventData) => void;
export type BatchPushEventCallback = (rescode: NIMResCode, result: Array<EventData>) => void;
export type PublishEventCallback = (rescode: NIMResCode, eventType: number, result: EventData) => void;
export type SubscribeEventCallback = (rescode: NIMResCode, eventType: number, failedList: Array<string>) => void;
export type UnSubscribeEventCallback = (rescode: NIMResCode, eventType: number, failedList: Array<string>) => void;
export type BatchUnSubscribeEventCallback = (rescode: NIMResCode, eventType: number) => void;
export type QuerySubscribeEventCallback = (rescode: NIMResCode, eventType: number, result: Array<EventSubscribeData>) => void;
export interface NIMSubscribeEventAPI {
    InitEventHandlers(): void;
    Publish(data: EventData, cb: PublishEventCallback | null, jsonExtension: string): boolean;
    Subscribe(eventType: NIMEventType, ttl: number, syncType: NIMEventSubscribeSyncEventType, accids: Array<string>, cb: SubscribeEventCallback | null, jsonExtension: string): boolean;
    UnSubscribe(eventType: NIMEventType, accids: Array<string>, cb: UnSubscribeEventCallback | null, jsonExtension: string): boolean;
    BatchUnSubscribe(eventType: NIMEventType, cb: BatchUnSubscribeEventCallback | null, jsonExtension: string): boolean;
    QuerySubscribe(eventType: NIMEventType, accids: Array<string>, cb: QuerySubscribeEventCallback | null, jsonExtension: string): void;
}