#import <IEMPushManager.h>
@header IEMPushManager.h @abstract 推送相关的管理协议类。
- 作者
- Hyphenate
- 版本
- 3.00
◆ clearRemindTypeForConversation:conversationType:completion:
- (void) clearRemindTypeForConversation: |
|
(NSString *_Nonnull) |
aConversationId |
conversationType: |
|
(EMConversationType) |
aConversationType |
completion: |
|
(void(^)(EMSilentModeResult *_Nullable aResult, EMError *_Nullable aError)) |
aCompletionBlock |
|
|
| |
清除会话离线推送消息提醒类型设置。
- 参数
-
aConversationId | 会话Id。 |
aConversationType | 会话类型。 |
aCompletionBlock | 该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。 |
◆ getPreferredNotificationLanguageCompletion:
- (void) getPreferredNotificationLanguageCompletion: |
|
(void(^)(NSString *_Nullable aLaguangeCode, EMError *_Nullable aError)) |
aCompletionBlock |
|
获取推送消息的翻译语言。
- 参数
-
aCompletionBlock | 该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。 |
◆ getPushNotificationOptionsFromServerWithCompletion:
- (void) getPushNotificationOptionsFromServerWithCompletion: |
|
(void(^)(EMPushOptions *_Nullable aOptions, EMError *_Nullable aError)) |
aCompletionBlock |
|
从服务器获取推送属性。
异步方法。
- 参数
-
aCompletionBlock | 该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。 |
◆ getPushOptionsFromServerWithError:
- (EMPushOptions *_Nullable) getPushOptionsFromServerWithError: |
|
(EMError *_Nullable *_Nullable) |
pError |
|
从服务器获取推送属性。
同步方法,会阻塞当前线程。
- 参数
-
- 返回
- 推送属性,详见 EMPushOptions。
◆ getPushTemplate:
- (void) getPushTemplate: |
|
(void(^)(NSString *_Nullable aPushTemplateName, EMError *_Nullable aError)) |
aCompletionBlock |
|
获取设置的离线推送模版。
- 参数
-
aCompletionBlock | 该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。 |
◆ getSilentModeForAllWithCompletion:
- (void) getSilentModeForAllWithCompletion: |
|
(void(^)(EMSilentModeResult *_Nullable aResult, EMError *_Nullable aError)) |
aCompletionBlock |
|
获取全局消息免打扰数据。
- 参数
-
aCompletionBlock | 该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。 |
◆ getSilentModeForConversation:conversationType:completion:
- (void) getSilentModeForConversation: |
|
(NSString *_Nonnull) |
aConversationId |
conversationType: |
|
(EMConversationType) |
aConversationType |
completion: |
|
(void(^)(EMSilentModeResult *_Nullable aResult, EMError *_Nullable aError)) |
aCompletionBlock |
|
|
| |
获取会话消息免打扰数据。
- 参数
-
aConversationId | 会话Id。 |
aConversationType | 会话类型。 |
aCompletionBlock | 该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。 |
◆ getSilentModeForConversations:completion:
- (void) getSilentModeForConversations: |
|
(NSArray< EMConversation * > *_Nonnull) |
aConversationArray |
completion: |
|
(void(^)(NSDictionary< NSString *, EMSilentModeResult * > *_Nullable aResult, EMError *_Nullable aError)) |
aCompletionBlock |
|
|
| |
获取多个会话免打扰数据设置。 注意:一次最多20条数据。如果没设置过或者设置失效,则结果字典中不会返回该条数据
- 参数
-
aConversationArray | 会话数组。 |
aCompletionBlock | 该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。 |
◆ setPreferredNotificationLanguage:completion:
- (void) setPreferredNotificationLanguage: |
|
(NSString *_Nullable) |
aLaguangeCode |
completion: |
|
(void(^)(EMError *_Nullable aError)) |
aCompletionBlock |
|
|
| |
设置推送消息的翻译语言。
- 参数
-
aLaguangeCode | 翻译语言代码。 |
aCompletionBlock | 该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。 |
◆ setPushTemplate:completion:
- (void) setPushTemplate: |
|
(NSString *_Nullable) |
aPushTemplateName |
completion: |
|
(void(^)(EMError *_Nullable aError)) |
aCompletionBlock |
|
|
| |
设置离线推送的推送模版。
- 参数
-
aPushTemplateName | 推送模版名称。 |
aCompletionBlock | 该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。 |
◆ setSilentModeForAll:completion:
设置全局消息免打扰数据。
- 参数
-
aParam | 免打扰数据参数模型,详见EMSilentModeParam。 |
aCompletionBlock | 该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。 |
◆ setSilentModeForConversation:conversationType:params:completion:
- (void) setSilentModeForConversation: |
|
(NSString *_Nonnull) |
aConversationId |
conversationType: |
|
(EMConversationType) |
aConversationType |
params: |
|
(EMSilentModeParam *_Nullable) |
aParam |
completion: |
|
(void(^)(EMSilentModeResult *_Nullable aResult, EMError *_Nullable aError)) |
aCompletionBlock |
|
|
| |
设置会话消息免打扰数据。
- 参数
-
aConversationId | 会话Id。 |
aConversationType | 会话类型。 |
aParam | 免打扰数据参数模型,详见EMSilentModeParam。 |
aCompletionBlock | 该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。 |
◆ syncSilentModeConversationsFromServerCompletion:
- (void) syncSilentModeConversationsFromServerCompletion: |
|
(void(^)(EMError *_Nullable error)) |
completionBlock |
|
从服务器获取所有会话免打扰。
- 参数
-
completionBlock | 该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。回调EMError 为空则可以调用IEMChatManager#getAllConversations 方法重新获取会话列表刷新UI |
◆ updatePushDisplayName:
- (EMError *_Nullable) updatePushDisplayName: |
|
(NSString *_Nonnull) |
aDisplayName |
|
设置推送消息显示的昵称。
同步方法,会阻塞当前线程。
- 参数
-
- 返回
- 错误信息,详见 EMError。
◆ updatePushDisplayName:completion:
- (void) updatePushDisplayName: |
|
(NSString *_Nonnull) |
aDisplayName |
completion: |
|
(void(^)(NSString *_Nullable aDisplayName, EMError *_Nullable aError)) |
aCompletionBlock |
|
|
| |
设置推送的显示的昵称。
异步方法。
- 参数
-
aDisplayName | 推送显示的昵称。 |
aCompletionBlock | 该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。 |
◆ updatePushDisplayStyle:
- (EMError *) updatePushDisplayStyle: |
|
(EMPushDisplayStyle) |
pushDisplayStyle |
|
设置推送消息显示的样式。
同步方法,会阻塞当前线程。
- 参数
-
pushDisplayStyle | 要设置的推送样式。 |
- 返回
- 错误信息,详见 EMError。
◆ updatePushDisplayStyle:completion:
设置推送的显示名。
异步方法。
- 参数
-
pushDisplayStyle | 推送显示样式。 |
aCompletionBlock | 该方法完成调用的回调。如果该方法调用失败,会包含调用失败的原因。 |
◆ pushOptions
该协议的文档由以下文件生成: