ANDROID.md

MTPush Hbuilder API ONLY For Android

引用方式

var mtpushModule = uni.requireNativePlugin("EL-MTPush");

停止推送服务

API - stopPush()

调用了本 API 后，MTPush 推送服务完全被停止。具体表现为： 收不到推送消息 极光推送所有的其他 API 调用都无效，不能通过 MTPushInterface.init 恢复，需要调用 resumePush 恢复。

示例

mtpushModule.stopPush();

恢复推送服务

API - resumePush()

调用了此 API 后，极光推送完全恢复正常工作。

示例

mtpushModule.resumePush();

设置允许推送时间 API

API - setPushTime(Object)

默认情况下用户在任何时间都允许推送。即任何时候有推送下来，客户端都会收到，并展示。

开发者可以调用此 API 来设置允许推送的时间。

如果不在该时间段内收到消息，SDK 的处理是：推送到的通知会被扔掉。

这是一个纯粹客户端的实现，所以与客户端时间是否准确、时区等这些，都有关系。 而且该接口仅对通知有效，自定义消息不受影响。

参数说明

• Object

参数名称	参数类型	参数说明
pushTimeDays	NumberArray	0 表示星期天，1 表示星期一，以此类推。 （ 7 天制，Set 集合里面的 int 范围为 0 到 6 ）
pushTimeStartHour	number	允许推送的开始时间 （ 24 小时制：startHour 的范围为 0 到 23 ）
pushTimeEndHour	number	允许推送的结束时间 （ 24 小时制：endHour 的范围为 0 到 23 ）

示例

mtpushModule.setPushTime({
					'pushTimeDays':[0,1,2],
                    'pushTimeStartHour':0,
                    'pushTimeEndHour':23
				});    

设置通知静默时间 API

API - setSilenceTime(Object)

默认情况下用户在收到推送通知时，客户端可能会有震动，响铃等提示。但用户在睡觉、开会等时间点希望为“免打扰”模式，也是静音时段的概念。

开发者可以调用此 API 来设置静音时段。如果在该时间段内收到消息，则：不会有铃声和震动。

参数说明

• Object

参数名称	参数类型	参数说明
silenceTimeStartHour	number	静音时段的开始时间 - 小时 （ 24 小时制，范围：0~23 ）
silenceTimeStartMinute	number	静音时段的开始时间 - 分钟（范围：0~59 ）
silenceTimeEndHour	number	静音时段的结束时间 - 小时 （ 24 小时制，范围：0~23 ）
silenceTimeEndMinute	number	静音时段的结束时间 - 分钟（范围：0~59 ）

示例

mtpushModule.setSilenceTime({
					'silenceTimeStartHour':22,
                    'silenceTimeStartMinute':30,
                    'silenceTimeEndHour':8
                    'silenceTimeEndMinute':30
				});    

清除通知 API

API - clearNotificationById()

此 API 提供清除通知的功能，清除指定某个通知。

示例

mtpushModule.clearNotificationById();

API - clearAllNotifications()

此 API 提供清除通知的功能，清除所有 MTPush 展现的通知（不包括非 MTPush SDK 展现的）；

示例

mtpushModule.clearAllNotifications();

设置国家码

API - setCountryCode()

该接口用来调试fcm通道。在国内如果需要调试fcm通道，需要设置setCountryCode,参数为"US"。 该接口只用来在debug模式调试使用，在正式环境请不要使用。

示例

mtpushModule.setCountryCode("US");