rammus library

Properties

deviceId → Future<String?>
确保注册成功以后调用获取deviceId
no setter
initCloudChannelResult → Stream<CommonCallbackResult>
注意可能被多次调用。 Android SDK文档原话如下： 如果设备成功注册，将回调callback.onSuccess()方法。 但如果注册服务器连接失败，则调用callback.onFailed方法，并且自动进行重新注册，直到onSuccess为止。（重试规则会由网络切换等时间自动触发。） 请在网络通畅的情况下进行相关的初始化调试，如果网络不通，或者App信息配置错误，在onFailed方法中，会有相应的错误码返回，可参考错误处理
no setter
onMessageArrived → Stream<CloudPushMessage>
no setter
onNotification → Stream<OnNotification>
no setter
onNotificationClickedWithNoAction → Stream<OnNotificationClickedWithNoAction>
no setter
onNotificationOpened → Stream<OnNotificationOpened>
no setter
onNotificationReceivedInApp → Stream<OnNotificationReceivedInApp>
no setter
onNotificationRemoved → Stream<String>
no setter
pushChannelStatus → Future<CommonCallbackResult>
no setter

Functions

addAlias(String alias) → Future<CommonCallbackResult>
Android 文档 添加别名 设备添加别名； 单个设备最多添加128个别名，且同一别名最多添加到128个设备； 别名支持128字节。
applicationBadgeNumberClean({int num = 0}) → Future
清理图标上的角标（包含ios，华为，其他平台需要自行实现）
badgeClean({int num = 0}) → Future
这个方法仅针对iOS 同步远程角标
bindAccount(String account) → Future<CommonCallbackResult>
Android 文档 将应用内账号和推送通道相关联，可以实现按账号的定点消息推送； 设备只能绑定一个账号，同一账号可以绑定到多个设备； 同一设备更换绑定账号时无需进行解绑，重新调用绑定账号接口即可生效； 若业务场景需要先解绑后绑定，在解绑账号成功回调中进行绑定绑定操作，以此保证执行的顺序性； 账户名设置支持64字节。
bindPhoneNumber(String phoneNumber) → Future<CommonCallbackResult>
Android only
bindTag({CloudPushServiceTarget? target, List<String>? tags, String? alias}) → Future<CommonCallbackResult>
Android 文档 绑定标签到指定目标； 支持向设备、账号和别名绑定标签，绑定类型由参数target指定； 绑定标签在10分钟内生效； App最多支持绑定1万个标签，单个标签最大支持128字符。 target 目标类型，1：本设备； 2：本设备绑定账号； 3：别名 target(V2.3.5及以上版本) 目标类型，CloudPushService.DEVICE_TARGET：本设备； CloudPushService.ACCOUNT_TARGET：本账号； CloudPushService.ALIAS_TARGET：别名 tags 标签（数组输入） alias 别名（仅当target = 3时生效） callback 回调
configureNotificationPresentationOption({bool none = false, bool sound = true, bool alert = true, bool badge = true}) → Future
这个方法仅针对iOS 设置推送通知显示方式 completionHandler(UNNotificationPresentationOptionSound | UNNotificationPresentationOptionAlert | UNNotificationPresentationOptionBadge);
dispose() → dynamic
listAliases() → Future<CommonCallbackResult>
Android 文档 查询设备别名； 查询结果可从回调onSuccess(response)的response中获取； 从V3.0.9及以上版本开始，接口内部有5s短缓存，5s内多次调用只会请求服务端一次。
listTags(CloudPushServiceTarget target) → Future<CommonCallbackResult>
Android 文档 查询目标绑定标签，当前仅支持查询设备标签； 查询结果可从回调onSuccess(response)的response获取； 标签绑定成功且生效（10分钟内）后即可查询。
register() → void
注册设备 仅在 Android 设备生效，且在 Android 端若希望插件正常工作，必须执行一次本方法 分离插件初始化与注册的过程，例如实现在用户同意了隐私政策后再进行远端注册，防止影响应用上架。
removeAlias(String alias) → Future<CommonCallbackResult>
Android 文档 删除别名 删除设备别名； 支持删除指定别名和删除全部别名（alias = null || alias.length = 0）。
setupNotificationManager(List<NotificationChannel> channels) → Future
这个方法只对android有效 最好调用这个方法以保证在Android 8以上推送通知好用。 如果不调用这个方法，请确认你自己创建了NotificationChannel。 为了更好的用户体验，一些参数请不要用传null。 id一定要和后台推送时候设置的通知通道一样，否则Android8.0以上无法完成通知推送。
turnOffPushChannel() → Future<CommonCallbackResult>
turnOnPushChannel() → Future<CommonCallbackResult>
这个返回结果永远都是true，并不是SDK初始化结果 初始化结果请监听initCloudChannelResult 只能初始化ios
unbindAccount() → Future<CommonCallbackResult>
unbindPhoneNumber() → Future<CommonCallbackResult>
Android only
unbindTag({CloudPushServiceTarget? target, List<String>? tags, String? alias}) → Future<CommonCallbackResult>
Android 文档 解绑指定目标标签； 支持解绑设备、账号和别名标签，解绑类型由参数target指定； 解绑标签在10分钟内生效； 解绑标签只是解除设备和标签的绑定关系，不等同于删除标签，即该APP下标签仍然存在，系统目前不支持标签的删除。 target 目标类型，1：本设备； 2：本设备绑定账号； 3：别名 target(V2.3.5及以上版本) 目标类型，CloudPushService.DEVICE_TARGET：本设备； CloudPushService.ACCOUNT_TARGET：本账号； CloudPushService.ALIAS_TARGET：别名 tags 标签（数组输入） alias 别名（仅当target = 3时生效） callback 回调