node-nim/types/qchat/attachment.d.ts

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

import { EventEmitter } from 'eventemitter3';
import { QChatAttachmentUploadParam, QChatAttachmentStopUploadParam, QChatAttachmentDownloadParam, QChatAttachmentStopDownloadParam, QChatAttachmentDownloadResp, QChatAttachmentUploadResp } from '../qchat_def/attachment_def';
export declare interface QChatAttachmentEvents {
    /** 上传全局回调，例如发送多媒体消息自动上传时会触发此回调 */
    upload: [QChatAttachmentUploadResp];
    /** 下载全局回调，例如接收多媒体消息自动下载时会触发此回调 */
    download: [QChatAttachmentDownloadResp];
    /** 上传/下载全局进度回调，例如多媒体消息自动上传/下载时会触发此回调 */
    progress: [QChatAttachmentDownloadResp];
}
export declare class QChatAttachmentModule extends EventEmitter<QChatAttachmentEvents> {
    instance: any;
    constructor();
    /** 注册全局回调 */
    initEventHandlers(): void;
    /** @fn upload(param: QChatAttachmentUploadParam)
     * 上传附件
     * @param[in] param 接口参数
     * @return void
     */
    upload(param: QChatAttachmentUploadParam): Promise<QChatAttachmentUploadResp>;
    /** @fn void StopUpload(const std::string& task_id)
     * 停止上传附件
     * @param[in] param 接口参数
     * @return void
     */
    stopUpload(param: QChatAttachmentStopUploadParam): void;
    /** @fn download(param: QChatAttachmentDownloadParam)
     * 下载附件
     * @param[in] param 接口参数
     * @return void
     */
    download(param: QChatAttachmentDownloadParam): Promise<QChatAttachmentDownloadResp>;
    /** @fn stopDownload(param: QChatAttachmentStopDownloadParam)
     * 停止下载附件
     * @param[in] param 接口参数
     * @return void
     */
    stopDownload(param: QChatAttachmentStopDownloadParam): void;
}