// Type definition for mtpush-react-native 2.6.6 type Callback = (result: T) => void; type Extra = { [key: string]: string; }; export type CommandExtra = { /** 与 errorCode 一致的小米整体结果码。 */ subscribe_code?: number; /** 回调来源厂商 ID,小米为 1。 */ platform?: number; /** 小米返回的各频道操作结果 JSON 字符串。 */ open_channel_result?: string; [key: string]: unknown; }; export type Sequence = { /** * 请求时传入的序列号,会在回调时原样返回 */ sequence: number; }; export type Tag = { /** * 有效的标签组成:字母(区分大小写)、数字、下划线、汉字、特殊字符@!#$&*+=.| * 限制:每个 tag 命名长度限制为 40 字节,最多支持设置 1000 个 tag,且单次操作总长度不得超过 5000 字节 *(判断长度需采用 UTF-8 编码)单个设备最多支持设置 1000 个 tag。App 全局 tag 数量无限制 */ tag: string; }; type Tags = { /** * 有效的标签组成:字母(区分大小写)、数字、下划线、汉字、特殊字符@!#$&*+=.| * 限制:每个 tag 命名长度限制为 40 字节,最多支持设置 1000 个 tag,且单次操作总长度不得超过 5000 字节 *(判断长度需采用 UTF-8 编码)单个设备最多支持设置 1000 个 tag。App 全局 tag 数量无限制 */ tags: string[]; }; type Alias = { /** * 有效的别名组成:字母(区分大小写)、数字、下划线、汉字、特殊字符@!#$&*+=.| * 限制:alias 命名长度限制为 40 字节。(判断长度需采用 UTF-8 编码) */ alias: string; }; type NotificationId = { /** * 通知 ID * */ notificationId: String; }; export default class MTPush { /** * 设置调试模式,默认关闭状态 * * 该接口需在 init 接口之前调用,避免出现部分日志没打印的情况 * @param {boolean} enable * */ static setLoggerEnable(enable: boolean): void; /* * 设置是否TCP加密连接,默认关闭状态 * * 该接口需在 init 接口之前调用,否则无效 * @param enable = boolean * */ static setTcpSSL(enable: boolean): void; /* * 设置设备更换时是否重置RegistrationID * * 该接口需在 init 接口之前调用,否则无效 * @param enable = boolean * */ static setEnableResetOnDeviceChange(enable: boolean): void; /* * 设置是否启用UDP * * 该接口需在 init 接口之前调用,否则无效 * @param enable = boolean * */ static setEnableUdp(enable: boolean): void; /* * 设置数据采集控制 * * 该接口需在 init 接口之前调用,否则无效 * 用于控制是否采集 GAID * 默认情况下 gaid 为 true(默认采集),设置为 false 可关闭对应数据采集 * @param params = {gaid?: boolean, aid?: boolean} * @deprecated params.aid - 自 Android SDK 5.4.0 起,AndroidId 默认不再采集,aid 参数已废弃,传入无效 * */ static setCollectControl(params: {gaid?: boolean, /** @deprecated 自 Android SDK 5.4.0 起废弃 */ aid?: boolean}): void; /* * 设置数据中心 * * 该接口需在 init 接口之前调用,否则无效。 不调用的话默认新加坡数据中心 * @param siteName 数据中心的名称 * */ static setSiteName(siteName: string): void; /* * 调试fcm * * 该接口用来测试fcm, 仅使用在测试环境,正式环境请不要调用。 * */ static testConfigGoogle(enable: boolean): void; /** * 初始化推送服务 * {"appKey":"","channel":"dev","production":1} * 请在componentDidMount()调用init,否则会影响通知点击事件的回调 * */ static init(params: { appKey: string; channel: string; production: boolean; }): void; /* * 上传厂商token 走tcp上传 * * @param params = {"platform":0,"token":"dev","region":""} * platform 厂商,取值范围(1:mi、2:huawei、3:meizu、4:oppo、5:vivo、7:honor、8:google) * token 厂商返回的token,不为空 * region 海外版小米和oppo需要设置region,根据使用地区等填如:“US”等,非海外版的填null * * 请在componentDidMount()调用init,否则会影响通知点击事件的回调 * 请先[init](#init),否则调用无效 * 由于走tcp上传,需要长连接成功即[onConnectStatus](#onConnectStatus)回调结果为ture后调用此接口 * */ static uploadPlatformToken(params: { platform: number; token: string; region: string; }): void; /** * 获取 RegistrationID * * 调用此 API 来取得应用程序对应的 RegistrationID。 * 只有当应用程序成功注册到 MTPush 的服务器时才返回对应的值,否则返回空字符串 * */ static getRegistrationID(callback: Callback<{ registerID: string }>): void; /** * 获取 冷启动通知内容 */ static getLaunchNoti(callback: Callback<{ launchNoti: Extra }>): void; //***************************************tags/alias******************************* /** * 新增标签 * * 这个接口是增加逻辑,而不是覆盖逻辑 */ static addTags(params: Sequence & Tags): void; /** * 覆盖标签 * * 需要理解的是,这个接口是覆盖逻辑,而不是增量逻辑。即新的调用会覆盖之前的设置 */ static updateTags(params: Sequence & Tags): void; /** * 删除指定标签 * */ static deleteTag(params: Sequence & Tags): void; /** * 清除所有标签 */ static deleteTags(params: Sequence): void; /** * 查询指定 tag 与当前用户绑定的状态 */ static queryTag(params: Sequence & Tag): void; /** * 查询所有标签 */ static queryTags(params: Sequence): void; /** * 设置别名 * 需要理解的是,这个接口是覆盖逻辑,而不是增量逻辑。即新的调用会覆盖之前的设置 */ static setAlias(params: Sequence & Alias): void; /** * 删除别名 */ static deleteAlias(params: Sequence): void; /** * 查询别名 */ static queryAlias(params: Sequence): void; /** * 进入页面 */ static pageEnterTo(params: String): void; /** * 离开页面 */ static pageLeave(params: String): void; //***************************************设置*************************************** /** * 跳转到通知设置界面 */ static goToAppNotificationSettings(): void; //***************************************统计*************************************** /** * 设置手机号码。该接口会控制调用频率,频率为 10s 之内最多 3 次 */ static setMobileNumber( params: { mobileNumber: string; } & Sequence ): void; // /** // * MTPush SDK 开启和关闭省电模式,默认为关闭。 // */ // static setPowerSaveMode(enable: boolean):void; // /** // * 检查当前应用的通知开关是否开启 // * */ // static isNotificationEnabled(callback: Callback): void; //***************************************本地通知*************************************** /** * 添加一个本地通知 * * messageID:唯一标识通知消息的ID,可用于移除消息 * * title:对应“通知标题”字段 * * content:对应“通知内容”字段 * * extras:对应“附加内容”字段 * */ static addLocalNotification(params: { messageID: string; title: string; content: string; extras: Extra; }): void; /** * 移除指定的本地通知 * * messageID:唯一标识通知消息的ID,可用于移除消息,通知ID */ static removeLocalNotification(params: { messageID: string }): void; /** * 移除所有的本地通知 * */ static clearLocalNotifications(): void; // /** // * 清除所有 MTPush 展现的通知(不包括非 MTPush SDK 展现的) // * // */ // static clearAllNotifications():void; // // /** // * 删除指定的通知 // * */ // static clearNotificationById(params: NotificationId):void; //***************************************接口回调*************************************** //连接状态 static addConnectEventListener( callback: Callback<{ connectEnable: boolean }> ): void; /** * 通知事件 * * 注意:应用在存活状态下点击通知不会有跳转行为,应用在被杀死状态下点击通知会启动应用 */ static addNotificationListener( callback: Callback<{ /** * messageID:唯一标识通知消息的 ID */ messageID: string; /** * 系统通知 ID(Android,整型) */ notificationId?: number; /** * title:对应 Portal 推送通知界面上的“通知标题”字段 */ title: string; /** * content:对应 Portal 推送通知界面上的“通知内容”字段 */ content: string; /** * badge:对应 Portal 推送通知界面上的可选设置里面的“badge”字段 (ios only) */ badge: string; /** * ring:对应 Portal 推送通知界面上的可选设置里面的“sound”字段 (ios only) */ ring: string; /** * extras:对应 Portal 推送消息界面上的“可选设置”里的附加字段 */ extras: Extra; /** * notificationEventType:ios只有notificationArrived和notificationOpened两种,android有notificationArrived和notificationOpened和notificationDismissed三种 */ notificationEventType: "notificationArrived" | "notificationOpened" | "notificationDismissed"; }> ): void; /** * 本地通知事件 * * 注意:应用在存活状态下点击通知不会有跳转行为,应用在被杀死状态下点击通知会启动应用 */ static addLocalNotificationListener( callback: Callback<{ /** * 唯一标识通知消息的ID,可用于移除消息 */ messageID: string; /** * 对应“通知标题”字段 */ title: string; /** * 对应“通知内容”字段 */ content: string; /** * 对应“附加内容”字段 */ extras: Extra; notificationEventType: "notificationArrived" | "notificationOpened" | "notificationDismissed"; }> ): void; /** * 自定义消息事件 */ static addCustomMessageListener( callback: Callback<{ /** * 唯一标识自定义消息的 ID */ messageID: string; /** * 对应 Portal 推送消息界面上的“自定义消息内容”字段 */ content: string; /** * 对应 Portal 推送消息界面上的“可选设置”里的附加字段 */ extras: Extra; }> ): void; /** * VoIP消息事件,支持厂商:小米、OPPO、vivo、荣耀 */ static addVoipMessageListener( callback: Callback<{ /** * 唯一标识VoIP消息的 ID */ messageID: string; /** * 应用的appkey */ appkey: string; /** * 业务自定义数据,对应服务端下发的 extraData 字段 */ extraData: string; /** * 厂商类型(1:小米、4:OPPO、5:vivo、7:荣耀) */ platform: number; }> ): void; /** * 通用命令结果事件(Android only)。 * 小米订阅消息结果也通过此事件返回。 */ static addCommandResultListener( callback: Callback<{ /** 小米频道订阅回调固定为 2012。 */ cmd: number; /** 小米整体结果码;0 表示弹窗正常展示并返回用户操作结果。 */ errorCode: number; /** 结果描述;当前订阅命令通常为空字符串。 */ msg: string; extra: CommandExtra; }> ): void; /** * 手机号码事件 */ static addMobileNumberListener( callback: Callback<{ code: number } & Sequence> ): void; /** * inapp消息事件 */ static addInappMessageListener( callback: Callback<{ /** * 唯一标识inapp消息的 ID */ mesageId: string; /** * 标题 */ title: string; /** * 内容 */ content: string; /** * 目标页面 */ target: string[]; /** * 跳转地址 */ clickAction: string; /** * 附加字段 */ extras: Extra; /** * 类型,inappShow:展示,inappClick:点击 */ inappEventType: "inappShow" | "inappClick"; }> ): void; /** * 增强提醒消息事件 iOS only */ static addNotiInappMessageListener( callback: Callback<{ /** * messageID:唯一标识通知消息的 ID */ messageID: string; /** * title:对应 Portal 推送通知界面上的“通知标题”字段 */ title: string; /** * content:对应 Portal 推送通知界面上的“通知内容”字段 */ content: string; /** * badge:对应 Portal 推送通知界面上的可选设置里面的“badge”字段 (ios only) */ badge: string; /** * ring:对应 Portal 推送通知界面上的可选设置里面的“sound”字段 (ios only) */ ring: string; /** * extras:对应 Portal 推送消息界面上的“可选设置”里的附加字段 */ extras: Extra; /** * notiInappEventType:有notiInappShow和notiInappClick两种 */ notiInappEventType: "notiInappShow" | "notiInappClick"; }> ): void; //移除事件 static removeListener(callback: Function): void; //***************************************Android Only*************************************** /** * 停止推送服务 * * @platform Android */ static stopPush(): void; /** * 恢复推送服务 * * @platform Android */ static resumePush(): void; /** 请求订阅 vivo 通知渠道;Promise 仅表示提交成功,最终结果通过 addCommandResultListener (cmd 2013) 返回。 */ static requestVivoSubscribeChannel(channelIds: string[]): Promise; /** * 请求订阅小米消息频道,结果通过 addCommandResultListener 返回。 * * @platform Android */ static requestSubscribeChannel(channelIds: string[]): void; /** * 设置允许推送时间 * * 默认情况下用户在任何时间都允许推送。即任何时候有推送下来,客户端都会收到,并展示。 * 开发者可以调用此 API 来设置允许推送的时间。 * 如果不在该时间段内收到消息,SDK 的处理是:推送到的通知会被扔掉。 * * 这是一个纯粹客户端的实现,所以与客户端时间是否准确、时区等这些,都没有关系。 * 而且该接口仅对通知有效,自定义消息不受影响。 * * @platform Android */ static setPushTime(params: { pushTimeDays: number[]; pushTimeStartHour: number; pushTimeEndHour: number; }): void; /** * 设置通知静默时间 * * 默认情况下用户在收到推送通知时,客户端可能会有震动,响铃等提示。 * 但用户在睡觉、开会等时间点希望为“免打扰”模式,也是静音时段的概念。 * 开发者可以调用此 API 来设置静音时段。如果在该时间段内收到消息,则:不会有铃声和震动。 * * @platform Android */ static setSilenceTime(params: { silenceTimeStartHour: number; silenceTimeStartMinute: number; silenceTimeEndHour: number; silenceTimeEndMinute: number; }): void; /** * 设置保留最近通知条数 * * 通过极光推送,推送了很多通知到客户端时,如果用户不去处理,就会有很多保留在那里。 * 调用此 API 可以限制保留的通知条数,默认为保留最近 5 条通知。 * * 仅对通知有效。所谓保留最近的,意思是,如果有新的通知到达,之前列表里最老的那条会被移除。 * 例如,设置为保留最近 5 条通知。假设已经有 5 条显示在通知栏,当第 6 条到达时,第 1 条将会被移除。 * * @platform Android */ static setLatestNotificationNumber(params: { notificationMaxNumber: number; }): void; /** * 动态配置 channel,优先级比 AndroidManifest 里配置的高 * * @platform Android */ static setChannel(params: { channel: string }): void; /* * 配置 appkey,优先级比 AndroidManifest 里配置的高 * */ static configAppKey(params:{ appkey: string }): void; /* * 上报厂商token * */ static uploadPlatformToken(params:{ /** * 厂商, 各个厂商取值: * 小米通道:1 * 华为通道:2 * 魅族通道:3 * oppo通道:4 * vivo通道:5 * honor通道:7 * google通道:8 */ platform: number, /** * 厂商返回的token */ token: string, /** * 海外版小米和oppo需要设置region,根据使用地区等填如:“US”等,非海外版的填"" */ region: string}) : void; /** * 清空厂商token * * @platform Android */ static clearPlatformToken(): void; /** * 上报自定义消息展示 */ static reportCustomDisplay(params: { /** Engagelab消息id,不为空 */ messageID: string, /** * 厂商,取值范围(0:Engagelab、2:huawei、7:honor、8:google),仅Android使用 */ platform?: number, /** 厂商消息id,可为空,仅Android使用 */ platformMessageId?: string }): void; /** * 上报自定义消息点击 */ static reportCustomClick(params: { /** Engagelab消息id,不为空 */ messageID: string, /** * 厂商,取值范围(0:Engagelab、2:huawei、7:honor、8:google),仅Android使用 */ platform?: number, /** 厂商消息id,可为空,仅Android使用 */ platformMessageId?: string }): void; /** * 厂商token回调 */ static addPlatformListener( callback: Callback<{ /** * 厂商对应的数字标识 */ platform: number; /** * 返回的厂商token */ token: string; }> ): void; //***************************************iOS Only*************************************** /** * 设置 Badge * * @platform iOS */ static setBadge(params: { /** * iOS Push封装badge功能,允许应用上传 badge 值至 MTPush 服务器,由 MTPush 后台帮助管理每个用户所对应的推送 badge 值,简化了设置推送 badge 的操作。设置的值小于0时,sdk时不作处理。 */ badge: number; /** * iOS/Android 用来标记应用程序状态的一个数字,出现在程序图标右上角。设置的值小于0时,sdk不作处理。(安卓仅华为/荣耀生效) */ appBadge: number; }): void; /** * 设置 Badge(带回调)- iOS Only * * @platform iOS */ static setBadgeWithCallback( params: { /** * iOS Push封装badge功能,允许应用上传 badge 值至 MTPush 服务器,由 MTPush 后台帮助管理每个用户所对应的推送 badge 值,简化了设置推送 badge 的操作。 */ badge: number; /** * iOS/Android 用来标记应用程序状态的一个数字,出现在程序图标右上角。设置的值小于0时,sdk不作处理。(安卓仅华为/荣耀生效) */ appBadge: number; }, /** * 回调函数,成功时返回{code: 0, message: "Badge set successfully"},失败时返回{code: -1, message: "失败原因"} */ callback: (result: { code: number; message: string } ) => void ): void; }