@rongcloud/plugin-call-plus 1.1.0 → 2.0.0

package/dist/index.d.ts

@@ -508,6 +508,14 @@ interface IStartCallCon {
      * 正在通话中的老版房间 ID (老版 call 或 meeting)
      */
     oldRoomId?: string;
+    /**
+      * 服务端接收的推送扩展
+      */
+    pushExt?: string;
+    /**
+     * 附加信息，服务器透传
+     */
+    extra?: string;
 }
 /**
  * 单呼信令内容
@@ -550,6 +558,14 @@ interface IStartSingleCon {
      * 组织ID
      */
     toOrgId?: string;
+    /**
+     * 附加信息，服务器透传
+     */
+    extra?: string;
+    /**
+     * 服务端接收的推送扩展
+     */
+    pushExt?: string;
 }
 /**
  * 群呼信令内容
@@ -583,6 +599,14 @@ interface IStartGroupCon {
      * 正在通话中的老版房间 ID (老版 call 或 meeting)
      */
     oldRoomId?: string;
+    /**
+     * 附加信息，服务器透传
+     */
+    extra?: string;
+    /**
+     * 服务端接收的推送扩展
+     */
+    pushExt?: string;
 }
 /**
  * 开始呼叫 Server 返回
@@ -611,6 +635,14 @@ interface IInviteCallCon extends IBaseSingalCon {
      * 目标用户列表
      */
     toUsers: IUser[];
+    /**
+     * 附加信息，服务器透传
+     */
+    extra?: string;
+    /**
+     * 服务端接收的推送扩展
+     */
+    pushExt?: string;
 }
 /**
  * 邀请好友加入信令结果
@@ -706,6 +738,10 @@ interface IPubInviteCon extends IBaseSingalCon {
       * 来源组 ID
       */
     targetId?: string;
+    /**
+     * 附加信息
+     */
+    extra?: string;
 }
 /**
  * 通话响铃信令内容
@@ -727,6 +763,10 @@ interface IJoinCallCon extends IBaseSingalCon {
  */
 interface IHangupCallCon extends IBaseSingalCon {
     sysStatus?: RCCallPlusReason;
+    /**
+     * 服务端接收的推送扩展
+     */
+    pushExt?: string;
 }
 /**
  * 通话状态上报信令内容
@@ -1265,6 +1305,14 @@ interface IStartCallOpts extends ICallId {
      * 传入后，会将此房间中的多端中的自己直接踢掉
      */
     oldRoomId?: string;
+    /**
+     * 推送扩展
+     */
+    pushConfig?: IRCCallPlusPushConfig;
+    /**
+     * 附加信息，服务器透传
+     */
+    extra?: string;
 }
 interface IStartCallResult {
     /**
@@ -1299,6 +1347,14 @@ interface IInviteOpts {
      * 来源组 ID
      */
     targetId?: string;
+    /**
+     * 推送扩展
+     */
+    pushConfig?: IRCCallPlusPushConfig;
+    /**
+     * 附加信息，服务器透传
+     */
+    extra?: string;
 }
 interface IInviteRes extends ICallId {
     callType: RCCallPlusType;
@@ -1311,6 +1367,10 @@ interface IHangupForBusyOpts extends ICallId {
      * 用户系统状态
      */
     systemState?: RCCallPlusReason;
+    /**
+     * 推送扩展
+     */
+    pushConfig?: IRCCallPlusPushConfig;
 }
 interface IJoinCallOpts {
     callId: string;
@@ -2034,7 +2094,7 @@ declare class RCCallPlusReportModule {
     * @returns
     */
     private _callAppListener;
-    onReceivedCall(session: RCCallPlusSession, traceId: string): void;
+    onReceivedCall(session: RCCallPlusSession, traceId: string, extra?: string): void;
     onRemoteUserInvited(inviteeUserList: string[], inviterUserId: string, callId: string): void;
     onCallConnected(session: RCCallPlusSession): void;
     onCallTypeChanged(callType: RCCallPlusType, callId: string, traceId: string): void;
@@ -2112,6 +2172,10 @@ declare class RCCallEngine extends EventEmitter {
      * 校时器
      */
     _timeCorrectioner: TimeCorrectioner;
+    /**
+     * client callId
+     */
+    private _clientCallId;
     /**
      * 构造器
      */
@@ -2523,8 +2587,9 @@ interface ICallPlusEventListener {
      * 呼入通知
      * 收到呼入时，可选择接听或挂断通话
      * @param session 通话实例
+     * @param extra 透传呼叫方发起呼叫时携带的附加信息
      */
-    onReceivedCall(session: RCCallPlusSession): void;
+    onReceivedCall(session: RCCallPlusSession, extra?: string): void;
     /**
      * 群组通话收到远端人员被邀请加入通话通知，如 A 与 B 通话中，A 邀请 C，则 B 会收到此回调
      * @param inviteeUserList - 受邀人用户 ID 列表
@@ -2766,6 +2831,132 @@ interface RCCallPlusCallUser {
     userId: string;
     state: RCCallPlusSessionUserState;
 }
+/**
+ * 推送信息配置项
+ */
+interface IRCCallPlusPushConfig {
+    /**
+     * 推送标题
+     */
+    pushTitle: string;
+    /**
+     * iOSConfig
+     */
+    iOSConfig?: IiOSPushConfig;
+    /**
+     * androidConfig
+     */
+    androidConfig?: IAndroidPushConfig;
+    /**
+     * 是否显示推送标题. 仅针对 iOS 平台有效
+     */
+    disablePushTitle?: boolean;
+    /**
+     * 推送模板id
+    */
+    templateId?: string;
+}
+/**
+ * ios 推送配置
+ */
+interface IiOSPushConfig {
+    /**
+     * iOS 用于通知分组的 id
+     */
+    threadId?: string;
+    /**
+     * iOS 用于通知覆盖的 id
+     */
+    apnsCollapseId?: string;
+    /**
+     * 和 category 对应
+     */
+    richMediaUri?: string;
+}
+/**
+ * 安卓推送配置
+ */
+interface IAndroidPushConfig {
+    /**
+     * 小米的 channelId
+     */
+    channelIdMi?: string;
+    /**
+     * 小米 Large icon 链接
+     * Large icon 可以出现在大图版和多字版消息中，显示在右边。
+     * 国内版仅 MIUI12 以上版本支持，以下版本均不支持；国际版支持。
+     * 图片要求：大小 120 * 120px，格式为 png 或者 jpg 格式。
+     */
+    miLargeIconUrl?: string;
+    /**
+     * 华为的 channelId
+     */
+    channelIdHW?: string;
+    /**
+     * 华为推送消息分类
+     * 更多信息请参考华为消息分类标准文档: https://developer.huawei.com/consumer/cn/doc/development/HMSCore-Guides/message-classification-0000001149358835
+    */
+    categoryHW?: string;
+    /**
+     * 华为推送消息级别
+     * LOW: 表示消息为资讯营销
+     * NORMAL: 消息为服务与通讯
+     */
+    importanceHW?: 'NORMAL' | 'LOW';
+    /**
+     * 华为通知类型的推送所使用的通知图片 url
+    */
+    imageUrlHW?: string;
+    /**
+     * OPPO 的 channelId
+     */
+    channelIdOPPO?: string;
+    /**
+     * vivo 的类型
+     */
+    typeVivo?: string;
+    /**
+     * Vivo 分类
+     * 即时消息[IM],账号与资产[ACCOUNT],日程待办[TODO],设备信息[DEVICE_REMINDER],订单与物流[ORDER],订阅提醒[SUBSCRIPTION]
+     * 运营消息分类
+     * 新闻[NEWS],内容推荐[CONTENT],运营活动[MARKETING],社交动态[SOCIAL]
+     */
+    categoryVivo?: string;
+    /**
+     * FCM 推送平台渠道 ID
+     */
+    fcmChannelId?: string;
+    /**
+     * FCM 通知类型推送时所使用的分组 id
+     */
+    fcmCollapseKey?: string;
+    /**
+     * FCM 通知类型的推送所使用的通知图片 url
+     */
+    fcmImageUrl?: string;
+    /**
+     * HONOR 推送级别
+     * LOW: 资讯营销类消息，NORMAL: 服务与通讯类消息
+     */
+    importanceHonor?: 'NORMAL' | 'LOW';
+    /**
+     * HONOR 推送所使用的通知图片 url
+     */
+    imageUrlHonor?: string;
+}
+/**
+ * 服务端需要的 pushConfig 数据格式
+ */
+interface IServerPushExt {
+    title: string;
+    templateId: string;
+    pushId: string;
+    disableTitle: boolean;
+    forceShowPushContent: boolean;
+    pushConfigs: {
+        [key: string]: any;
+    }[];
+}
 
 declare class RCAudioConfigBuilder {
     private _logger;
@@ -2818,6 +3009,75 @@ declare class RCVideoConfigBuilder {
     build(): IVideoConfig;
 }
 
+declare class RCCallPlusAndroidPushConfigBuilder {
+    private _logger;
+    private _androidPushConfig;
+    constructor(_logger: BasicLogger);
+    /**
+     * 设置小米的 channelId
+     */
+    setChannelIdMi(channelIdMi: string): this;
+    /**
+     * 设置小米 Large icon 链接
+     */
+    setMiLargeIconUrl(miLargeIconUrl: string): this;
+    /**
+     * 设置华为的 channelId
+     */
+    setChannelIdHW(channelIdHW: string): this;
+    /**
+     * 设置华为推送消息分类
+     */
+    setCategoryHW(categoryHW: string): this;
+    /**
+     * 设置华为推送消息级别
+     */
+    setImportanceHW(importanceHW: 'NORMAL' | 'LOW'): this;
+    /**
+     * 设置华为通知类型的推送所使用的通知图片 url
+    */
+    setImageUrlHW(imageUrlHW: string): this;
+    /**
+     * 设置 OPPO 的 channelId
+     */
+    setChannelIdOPPO(channelIdOPPO: string): this;
+    /**
+     * 设置 vivo 的类型
+     */
+    setTypeVivo(typeVivo: string): this;
+    /**
+     * 设置 Vivo 分类
+     */
+    setCategoryVivo(categoryVivo: string): this;
+    /**
+    * 设置 FCM 推送平台渠道 ID
+    */
+    setFcmChannelId(fcmChannelId: string): this;
+    /**
+     * 设置 FCM 通知类型推送时所使用的分组 id
+     */
+    setFcmCollapseKey(fcmCollapseKey: string): this;
+    /**
+     * 设置 FCM 通知类型的推送所使用的通知图片 url
+     */
+    setFcmImageUrl(fcmImageUrl: string): this;
+    /**
+     * 设置 HONOR 推送级别
+     * LOW: 资讯营销类消息，NORMAL: 服务与通讯类消息
+     */
+    setimportanceHonor(importanceHonor: 'NORMAL' | 'LOW'): this;
+    /**
+     * 设置 HONOR 推送所使用的通知图片 url
+     */
+    setimageUrlHonor(imageUrlHonor: string): this;
+    /**
+     * 构建 IAndroidPushConfig
+     * @returns IAndroidPushConfig 安卓推送配置数据
+     * 返回值需传入 startCall、invite、hangup 方法的 pushConfig.androidConfig 中
+     */
+    build(): IAndroidPushConfig;
+}
+
 declare class RCCallPlusClient {
     private readonly _context;
     private readonly _logger;
@@ -2954,6 +3214,13 @@ declare class RCCallPlusClient {
      * 设置完需调 build 方法，最终在 setAudioConfig 后生效
      */
     createAudioConfigBuilder(): RCAudioConfigBuilder;
+    /**
+     * 创建安卓推送信息构建器
+     * @returns RCCallPlusAndroidPushConfigBuilder 用于构造安卓推送信的配置项
+     * 设置完需调 build 方法获取设置的 androidPushConfig 数据
+     * 最终需把 androidPushConfig 传入 startCall、invite、hangup 方法的 pushConfig.androidConfig 中
+     */
+    createAndroidPushConfigBuilder(): RCCallPlusAndroidPushConfigBuilder;
     /**
      * 设置音频配置
      * 下次采集时生效，如重新建立通话
@@ -2966,9 +3233,11 @@ declare class RCCallPlusClient {
      * @param userIds 被叫人员 userId 列表，单人呼叫仅需在数组中放置对方一人的 userId
      * @param type 单人呼叫 or 多人呼叫
      * @param mediaType 通话媒体类型: 音频 or 音视频
+     * @param pushConfig 移动端推送信息
+     * @param extra 附加信息，会透传给被呼叫方
      * @returns callId 呼叫成功后，产生的会话 id
      */
-    startCall(userIds: string[], callType?: RCCallPlusType, mediaType?: RCCallPlusMediaType): Promise<{
+    startCall(userIds: string[], callType?: RCCallPlusType, mediaType?: RCCallPlusMediaType, pushConfig?: IRCCallPlusPushConfig, extra?: string): Promise<{
         code: number;
         callId?: string;
     }>;
@@ -2983,9 +3252,11 @@ declare class RCCallPlusClient {
      * 通话中邀请他人
      * 单人通话中邀请他人会引发通话类型变更
      * @param userIds 被邀请人列表
+     * @param pushConfig 移动端推送信息
+     * @param extra 附加信息，会透传给被邀请方
      * @returns busyUsers 返回忙线人员列表
      */
-    invite(userIds: string[]): Promise<{
+    invite(userIds: string[], pushConfig?: IRCCallPlusPushConfig, extra?: string): Promise<{
         code: number;
         busyUsers?: RCCallPlusCallUser[];
     }>;
@@ -3001,8 +3272,9 @@ declare class RCCallPlusClient {
      * 挂断通话
      * @param callId 为可选参数，不传时，挂断正在进行的主 session，传入时可指定挂断主通话或暂未建立连接的通话
      * 暂未建立连接的通话：指已在通话中时，收到呼叫但暂未接听的通话
+     * @param pushConfig 移动端推送信息
      */
-    hangup(callId?: string): Promise<{
+    hangup(callId?: string, pushConfig?: IRCCallPlusPushConfig): Promise<{
         code: number;
     }>;
     /**
@@ -3109,7 +3381,7 @@ declare class RCCallPlusClient {
     isMicrophoneEnabled(): boolean;
     /**
      * 设置所有远端音频流是否可用
-     * @param enable 为 true 时，静音所有远端音频流；为 false 时，启用所有远端音频流
+     * @param enable 为 true 时，启用所有远端音频流；为 false 时，静音所有远端音频流
      */
     setAllRemoteAudioEnable(enable: boolean): Promise<{
         code: number;
@@ -3131,4 +3403,4 @@ declare class RCCallPlusClient {
 
 declare const installer: IPluginGenerator<RCCallPlusClient, ICallPlusInitOpts>;
 
-export { IAudioConfig, IAudioConfigBuilder, ICallOpts, ICallPlusEventListener, ICallPlusInitOpts, IRCCallPlusCallRecord, IRCCallPlusGetCallRecordRes, IStatusReportListener, IVideoConfig, IVideoConfigBuilder, RCAudioConfigBuilder, RCCallPlusCallState, RCCallPlusCallUser, RCCallPlusClient, RCCallPlusCode, RCCallPlusMediaType, RCCallPlusMediaTypeChangeResult, RCCallPlusPacketLossStats, RCCallPlusReason, RCCallPlusSession, RCCallPlusSessionUserState, RCCallPlusType, RCVideoConfigBuilder, installer };
+export { IAndroidPushConfig, IAudioConfig, IAudioConfigBuilder, ICallOpts, ICallPlusEventListener, ICallPlusInitOpts, IRCCallPlusCallRecord, IRCCallPlusGetCallRecordRes, IRCCallPlusPushConfig, IServerPushExt, IStatusReportListener, IVideoConfig, IVideoConfigBuilder, IiOSPushConfig, RCAudioConfigBuilder, RCCallPlusAndroidPushConfigBuilder, RCCallPlusCallState, RCCallPlusCallUser, RCCallPlusClient, RCCallPlusCode, RCCallPlusMediaType, RCCallPlusMediaTypeChangeResult, RCCallPlusPacketLossStats, RCCallPlusReason, RCCallPlusSession, RCCallPlusSessionUserState, RCCallPlusType, RCVideoConfigBuilder, installer };