react-native-getui/index.d.ts

Getui push sdk plugin for rect-native

export default class Getui {
	/**
	 * 初始化推送服务 只有Android,  IOS在AppDelegate中初始化
	 */
	static initPush(): void;

	/**
	 * 销毁SDK，并且释放资源
	 */
	static destroy(): void;

	/**
	 * 恢复SDK运行,IOS7 以后支持Background Fetch方式，后台定期更新数据,该接口需要在Fetch起来后被调用，保证SDK 数据获取。
	 */
	static resume(): void;

	static clearAllNotificationForNotificationBar(): void;

	/**
	 * 打开推送服务
	 */
	static turnOnPush(): void;

	static turnOffPush(): void;

	/**
	 * 获取SDK的Cid
	 *
	 * @param cb 回调函数，接收 Cid 值
	 */
	static clientId(cb: (param: string) => void): void;

	/**
	 * 获取SDK运行状态
	 *
	 * @param cb 回调函数，接收运行状态
	 */
	static status(cb: (param: string) => void): void;

	/**
	 * 获取SDK版本号
	 *
	 * @param cb 回调函数，接收版本值
	 */
	static version(cb: (param: string) => void): void;

	/**
		 * 是否允许SDK 后台运行（默认值：NO）
		 * 备注：可以未启动SDK就调用该方法
		 * 警告：该功能会和音乐播放冲突，使用时请注意
		 *
		 * @param isEnable 支持当APP进入后台后，个推是否运行,YES.允许
		 */
	static runBackgroundEnable(isEnable: boolean): void;

	/**
	 * 地理围栏功能，设置地理围栏是否运行
	 * 备注：SDK可以未启动就调用该方法
	 *
	 * @param isEnable 设置地理围栏功能是否运行（默认值：NO）
	 * @param isVerify 设置是否SDK主动弹出用户定位请求（默认值：NO）
	 */
	static lbsLocationEnable(isEnable: boolean, isVerify: boolean): void;

	/**
	 * 设置渠道
	 * 备注：SDK可以未启动就调用该方法
	 *
	 * SDK-1.5.0+
	 *
	 * @param aChannelId 渠道值，可以为空值
	 */
	static setChannelId(aChannelId: string): void;

	/**
	 * 向个推服务器注册DeviceToken
	 * 备注：可以未启动SDK就调用该方法
	 *
	 * @param deviceToken 推送时使用的deviceToken
	 */
	static registerDeviceToken(deviceToken: string): void;

	/**
	 * 绑定别名功能:后台可以根据别名进行推送
	 *
	 * @param alias 别名字符串
	 * @param aSn 绑定序列码, 不为nil
	 */
	static bindAlias(alias: string, aSn?: string): void;

	/**
	 * 取消绑定别名功能
	 *
	 * @param alias 别名字符串
	 * @param aSn 绑定序列码, 不为nil
	 */
	static unbindAlias(alias: string, aSn?: string): void;

	/**
	 * 给用户打标签 , 后台可以根据标签进行推送
	 *
	 * @param tags 别名数组
	 *
	 * @return 提交结果，YES表示尝试提交成功，NO表示尝试提交失败
	 */
	static setTag(tags: string[]): boolean;

	/**
	 * 设置关闭推送模式（默认值：NO）
	 *
	 * @param isValue 消息推送开发，YES.关闭消息推送 NO.开启消息推送
	 *
	 * SDK-1.2.1+
	 */
	static setPushModeForOff(isValue: boolean): void;

	/**
	 * 同步角标值到个推服务器
	 * 该方法只是同步角标值到个推服务器，本地仍须调用setApplicationIconBadgeNumber函数
	 *
	 * SDK-1.4.0+
	 *
	 * @param value 角标数值
	 */
	static setBadge(value: number): void;

	/**
	 * 重置角标值
	 */
	static resetBadge(): void;

	/**
	 * SDK发送上行消息结果
	 *
	 * @param body 需要发送的消息数据
	 * @param error 如果发送成功返回messageid，发送失败返回nil
	 *
	 * @return 消息的msgId
	 */
	static sendMessage(body: string, cb: (param: boolean) => void): string;

	/**
	 * 上行第三方自定义回执actionid
	 *
	 * @param actionId 用户自定义的actionid，int类型，取值90001-90999。
	 * @param taskId 下发任务的任务ID
	 * @param msgId 下发任务的消息ID
	 * @param cb 回调函数，接收提交结果
	 *
	 * @return BOOL，YES表示尝试提交成功，NO表示尝试提交失败。注：该结果不代表服务器收到该条数据
	 * 该方法需要在回调方法“GeTuiSdkDidReceivePayload:andTaskId:andMessageId:andOffLine:fromApplication:”使用
	 */
	static sendFeedbackMessage(actionId: number, taskId: string, msgId: string, cb: (param: boolean) => void): void;

	/**
	 * 注册实时活动token（灵动岛）
	 * @param liveActivityId  业务id，用于绑定token的业务关系
	 * @param token liveActivity推送时使用的pushToken
	 * @param sn 请求序列码, 不为nil
	 * @param cb 回调函数，接收提交结果
	 */
	static registerLiveActivity(liveActivityId: string, token: string, sn: string, cb: (param: boolean) => void): string;

	/**
	 * 注册实时活动PushToStartToken（灵动岛）
	 * @param activityAttributes  实时活动的属性
	 * @param pushToStartToken 推送时使用的pushToStartToken
	 * @param sn 请求序列码, 不为nil
	 * @param cb 回调函数，接收提交结果
	 */
	static registerPushToStartToken(activityAttributes: string, pushToStartToken: string, sn: string, cb: (param: boolean) => void): string;


}