HyphenateChatSDK 4.5.0
构造函数 | 属性 | 所有成员列表
<IEMPushManager>协议 参考

#import <IEMPushManager.h>

类 <IEMPushManager> 继承关系图:

构造函数

(NSArray *noPushUIds) - EM_DEPRECATED_IOS
 
(NSArray *noPushGroups) - EM_DEPRECATED_IOS
 
(3_7_3, 3_9_1, "Use -setSilentModeForAll:completion: instead") - EM_DEPRECATED_IOS
 
(EMError *) - disableOfflinePushStart:end:
 
(EMError *) - updatePushServiceForGroups:disablePush:
 
(void) - updatePushServiceForGroups:disablePush:completion:
 
(EMError *) - updatePushServiceForUsers:disablePush:
 
(void) - updatePushServiceForUsers:disablePush:completion:
 
(EMError *) - updatePushDisplayStyle:
 
(void) - updatePushDisplayStyle:completion:
 
(EMError *_Nullable) - updatePushDisplayName:
 
(void) - updatePushDisplayName:completion:
 
(EMPushOptions *_Nullable) - getPushOptionsFromServerWithError:
 
(void) - getPushNotificationOptionsFromServerWithCompletion:
 
(void) - setSilentModeForAll:completion:
 
(void) - getSilentModeForAllWithCompletion:
 
(void) - setSilentModeForConversation:conversationType:params:completion:
 
(void) - getSilentModeForConversation:conversationType:completion:
 
(void) - clearRemindTypeForConversation:conversationType:completion:
 
(void) - getSilentModeForConversations:completion:
 
(void) - setPreferredNotificationLanguage:completion:
 
(void) - getPreferredNotificationLanguageCompletion:
 
(void) - setPushTemplate:completion:
 
(void) - getPushTemplate:
 

属性

EMPushOptions *_Nullable pushOptions
 

详细描述

@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该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ disableOfflinePushStart:end:

- (EMError *) disableOfflinePushStart: (int)  aStartHour
end: (3_7_3) 
(3_9_1) 
("Use -setSilentModeForAll:completion: instead")  EM_DEPRECATED_IOS 

关闭离线推送。 已废弃，使用 -setSilentModeForAll:completion: 代替。

同步方法，会阻塞当前线程。

参数
aStartHour开始时间。
aEndHour结束时间。
返回
错误信息，详见 EMError。

◆ EM_DEPRECATED_IOS [1/3]

- (3_7_3, 3_9_1, "Use -)setSilentModeForAll:

开启离线推送。 已废弃，使用 -setSilentModeForAll:completion: 代替。

同步方法，会阻塞当前线程。

返回
错误信息，详见 EMError。

◆ EM_DEPRECATED_IOS [2/3]

- (NSArray *noPushGroups) EM_DEPRECATED_IOS (3_7_4) 
(3_9_1) 
("Use -getSilentModeForConversations:completion: instead")   

从内存中获取屏蔽了推送的群组 ID 列表。 已废弃，使用getSilentModeForConversations:completion:精确获取批量会话推送设置。

◆ EM_DEPRECATED_IOS [3/3]

- (NSArray *noPushUIds) EM_DEPRECATED_IOS (3_8_4) 
(3_9_1) 
("Use -getSilentModeForConversations:completion: instead")   

从内存中获取屏蔽了推送的用户 ID 列表。 已废弃，使用getSilentModeForConversations:completion:精确批量获取代替。

◆ 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

从服务器获取推送属性。

同步方法，会阻塞当前线程。

参数
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:

- (void) setSilentModeForAll: (EMSilentModeParam *_Nullable)  aParam
completion: (void(^)(EMSilentModeResult *_Nullable aResult, EMError *_Nullable aError))  aCompletionBlock 

设置全局消息免打扰数据。

参数
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该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ updatePushDisplayName:

- (EMError *_Nullable) updatePushDisplayName: (NSString *_Nonnull)  aDisplayName

设置推送消息显示的昵称。

同步方法，会阻塞当前线程。

参数
aNickname要设置的昵称。
返回
错误信息，详见 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:

- (void) updatePushDisplayStyle: (EMPushDisplayStyle)  pushDisplayStyle
completion: (void(^)(EMError *_Nullable aError))  aCompletionBlock 

设置推送的显示名。

异步方法。

参数
pushDisplayStyle推送显示样式。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ updatePushServiceForGroups:disablePush:

- (EMError *) updatePushServiceForGroups: (NSArray *)  aGroupIds
disablePush: (3_7_4) 
(3_9_1) 
("Use -setSilentModeForConversation:conversationType:params:completion: instead")  EM_DEPRECATED_IOS 

设置群组是否接收推送。 已废弃，使用 -setSilentModeForConversation:conversationType: params:completion:代替。

同步方法，会阻塞当前线程。

参数
aGroupIds群组 ID。
disable是否接收推送。
返回
错误信息，详见 EMError。

◆ updatePushServiceForGroups:disablePush:completion:

- (void) updatePushServiceForGroups: (NSArray *)  aGroupIds
disablePush: (BOOL)  disable
completion: (3_7_4) 
(3_9_1) 
("Use -setSilentModeForConversation:conversationType: params:completion: instead")  EM_DEPRECATED_IOS 

设置群组是否接收推送。 已废弃，使用 -setSilentModeForConversation:conversationType: params:completion:代替。

异步方法。

参数
aGroupIds群组 ID。
disable是否接收推送。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

◆ updatePushServiceForUsers:disablePush:

- (EMError *) updatePushServiceForUsers: (NSArray *)  aUIds
disablePush: (3_8_4) 
(3_9_1) 
("Use -setSilentModeForConversation:conversationType: params:completion: instead")  EM_DEPRECATED_IOS 

设置是否接收联系人消息推送。 已废弃，使用 -setSilentModeForConversation:conversationType: params:completion:代替。

同步方法，会阻塞当前线程。

参数
aUIds用户 ID。
disable是否不接收推送。默认值是 NO，表示接收推送；设置 YES，表示不接收推送。
返回
错误信息。

◆ updatePushServiceForUsers:disablePush:completion:

- (void) updatePushServiceForUsers: (NSArray *)  aUIds
disablePush: (BOOL)  disable
completion: (3_8_4) 
(3_9_1) 
("Use -setSilentModeForConversation:conversationType: params:completion: instead")  EM_DEPRECATED_IOS 

设置是否接收联系人消息推送。 已废弃，使用 -setSilentModeForConversation:conversationType: params:completion:代替。

异步方法。

参数
aUIds用户 ID。
disable是否不接收推送。默认值是 NO，表示接收推送；设置 YES，表示不接收推送。
aCompletionBlock该方法完成调用的回调。如果该方法调用失败，会包含调用失败的原因。

属性说明

◆ pushOptions

- (EMPushOptions* _Nullable) pushOptions
readnonatomicstrong

消息推送配置选项。

该协议的文档由以下文件生成:
制作者 doxygen 1.9.4