public class PushApi extends Object
限定符和类型 | 方法和说明 |
---|---|
reactor.core.publisher.Mono<Void> |
closeNotificationNoDisturbing(String username)
取消推送免打扰。
|
reactor.core.publisher.Mono<Void> |
offlineSetting(String username,
EMConversationType conversationType,
String conversationId,
EMNotificationType notificationType,
String ignoreInterval,
long ignoreDuration)
设置离线推送设置
|
reactor.core.publisher.Mono<Void> |
openNotificationNoDisturbing(String username,
int startTime,
int endTime)
设置推送免打扰。
|
reactor.core.publisher.Mono<Void> |
setNotificationDisplayStyle(String username,
DisplayStyle style)
设置推送消息展示方式,指客户端的推送通知栏展示消息的样式。
|
reactor.core.publisher.Mono<Void> |
updateUserNickname(String username,
String nickname)
设置推送昵称。
|
reactor.core.publisher.Mono<Void> |
updateUserNicknames(List<EMPushNickname> pushNicknames)
批量设置离线推送时显示的昵称。
|
public PushApi(Context context)
public reactor.core.publisher.Mono<Void> updateUserNickname(String username, String nickname)
API使用示例:
EMService service;
try {
service.push().updateUserNickname("username", "nickname").block();
} catch (EMException e) {
e.getErrorCode();
e.getMessage();
}
username
- 用户名nickname
- 推送昵称Mono
public reactor.core.publisher.Mono<Void> updateUserNicknames(List<EMPushNickname> pushNicknames)
API使用示例:
EMService service;
try {
List<EMPushNickname> pushNicknames = new ArrayList<>();
pushNicknames.add(new EMPushNickname("user1", "推送昵称-1"));
pushNicknames.add(new EMPushNickname("user2", "推送昵称-2"));
service.push().updateUserNicknames(pushNicknames).block();
} catch (EMException e) {
e.getErrorCode();
e.getMessage();
}
pushNicknames
- 需要设置离线推送时显示的昵称列表,EMPushNickname 中包含用户名以及推送昵称,推送昵称长度不能超过 100 个字符。 支持以下字符集: \- 26 个小写英文字母 a-z; \- 26 个大写英文字母 A-Z; \- 10 个数字 0-9; \- 中文; \- 特殊字符。Mono
public reactor.core.publisher.Mono<Void> setNotificationDisplayStyle(String username, DisplayStyle style)
API使用示例:
EMService service;
try {
service.push().setNotificationDisplayStyle("username", DisplayStyle.DETAILS).block();
} catch (EMException e) {
e.getErrorCode();
e.getMessage();
}
username
- 用户名style
- 展示方式,DEFAULT 仅通知,DETAILS 通知以及消息详情Mono
public reactor.core.publisher.Mono<Void> openNotificationNoDisturbing(String username, int startTime, int endTime)
设置 IM 用户免打扰,在免打扰期间,用户将不会收到离线消息推送。
API使用示例:
EMService service;
try {
service.push().openNotificationNoDisturbing("username", 10, 13).block();
} catch (EMException e) {
e.getErrorCode();
e.getMessage();
}
username
- 用户名startTime
- 免打扰起始时间,单位是小时endTime
- 免打扰结束时间,单位是小时Mono
public reactor.core.publisher.Mono<Void> closeNotificationNoDisturbing(String username)
设置 IM 用户免打扰,在免打扰期间,用户将不会收到离线消息推送。
API使用示例:
EMService service;
try {
service.push().closeNotificationNoDisturbing("username").block();
} catch (EMException e) {
e.getErrorCode();
e.getMessage();
}
username
- 用户名Mono
public reactor.core.publisher.Mono<Void> offlineSetting(String username, EMConversationType conversationType, String conversationId, EMNotificationType notificationType, String ignoreInterval, long ignoreDuration)
username
- 用户名conversationType
- 会话类型conversationId
- 会话Id,单聊时为对端用户的用户 ID,群聊时为群组 IDnotificationType
- 离线推送通知方式ignoreInterval
- 离线推送免打扰时间段,精确到分钟,格式为 HH:MM-HH:MM,例如 08:30-10:00。
该时间为 24 小时制,免打扰时间段的开始时间和结束时间中的小时数和分钟数的取值范围分别为 [00,23] 和 [00,59]。
免打扰时段的设置仅针对 app 生效,对单聊或群聊不生效。如需设置 app 的免打扰时段,type 指定为 user,key 指定为当前用户 IDignoreDuration
- 离线推送免打扰时长,单位为毫秒。该参数的取值范围为 [0,604800000],0 表示该参数无效,604800000 表示免打扰模式持续 7 天Mono
Copyright © 2024. All rights reserved.