<IEMPushManager> Protocol Reference

#import <IEMPushManager.h>

Inheritance diagram for <IEMPushManager>:

Instance Methods
(EMError *)	- updatePushDisplayStyle:
(void)	- updatePushDisplayStyle:completion:
(EMError *_Nullable)	- updatePushDisplayName:
(void)	- updatePushDisplayName:completion:
(EMPushOptions *_Nullable)	- getPushOptionsFromServerWithError:
(void)	- getPushNotificationOptionsFromServerWithCompletion:
(void)	- setSilentModeForAll:completion:
(void)	- getSilentModeForAllWithCompletion:
(void)	- syncSilentModeConversationsFromServerCompletion:
(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:

Properties
EMPushOptions *_Nullable	pushOptions

Detailed Description

@header IEMPushManager.h @abstract The push related management protocol class.

Author

Hyphenate

Version

3.00

Method Documentation

clearRemindTypeForConversation:conversationType:completion:

- (void) clearRemindTypeForConversation:		(NSString *_Nonnull)	aConversationId
conversationType:		(EMConversationType)	aConversationType
completion:		(void(^)(EMSilentModeResult *_Nullable aResult, EMError *_Nullable aError))	aCompletionBlock

Clear conversation remind type for push messages.

Parameters

aConversationId	The conversation Id.
aConversationType	The conversation type.
aCompletionBlock	The completion block, which contains the error message if the method fails.

getPreferredNotificationLanguageCompletion:

- (void) getPreferredNotificationLanguageCompletion:

(void(^)(NSString *_Nullable aLaguangeCode, EMError *_Nullable aError))

aCompletionBlock

Get the translation language for push messages.

Parameters

aCompletionBlock

The completion block, which contains the error message if the method fails.

getPushNotificationOptionsFromServerWithCompletion:

- (void) getPushNotificationOptionsFromServerWithCompletion:

(void(^)(EMPushOptions *_Nullable aOptions, EMError *_Nullable aError))

aCompletionBlock

Gets the push options from the server.

This is an asynchronous method.

Parameters

aCompletionBlock

The completion block, which contains the error message if the method fails.

getPushOptionsFromServerWithError:

- (EMPushOptions *_Nullable) getPushOptionsFromServerWithError:

(EMError *_Nullable *_Nullable)

pError

Gets the push options from the server.

This is a synchronous method and blocks the current thread.

Parameters

pError

The error information if the method fails: Error.

Returns

The push options. See EMPushOptions.

getPushTemplate:

- (void) getPushTemplate:

(void(^)(NSString *_Nullable aPushTemplateName, EMError *_Nullable aError))

aCompletionBlock

Gets the offline push template for Settings.

Parameters

aCompletionBlock

The completion block, which contains the error message if the method fails.

getSilentModeForAllWithCompletion:

- (void) getSilentModeForAllWithCompletion:

(void(^)(EMSilentModeResult *_Nullable aResult, EMError *_Nullable aError))

aCompletionBlock

Get global silent mode message data.

Parameters

aCompletionBlock

The completion block, which contains the error message if the method fails.

getSilentModeForConversation:conversationType:completion:

- (void) getSilentModeForConversation:		(NSString *_Nonnull)	aConversationId
conversationType:		(EMConversationType)	aConversationType
completion:		(void(^)(EMSilentModeResult *_Nullable aResult, EMError *_Nullable aError))	aCompletionBlock

Get conversation silent mode message data.

Parameters

aConversationId	The conversation Id.
aConversationType	The conversation type.
aCompletionBlock	The completion block, which contains the error message if the method fails.

getSilentModeForConversations:completion:

- (void) getSilentModeForConversations:		(NSArray< EMConversation * > *_Nonnull)	aConversationArray
completion:		(void(^)(NSDictionary< NSString *, EMSilentModeResult * > *_Nullable aResult, EMError *_Nullable aError))	aCompletionBlock

Gets the silent mode data setting for multiple sessions. Notice:A maximum of 20 pieces of data at a time.If it is not set or set to expire , it will not be returned in the result dictionary

Parameters

aConversationArray	The conversations array。
aCompletionBlock	The completion block, which contains the error message if the method fails.

setPreferredNotificationLanguage:completion:

- (void) setPreferredNotificationLanguage:		(NSString *_Nullable)	aLaguangeCode
completion:		(void(^)(EMError *_Nullable aError))	aCompletionBlock

Set the translation language for push messages.

Parameters

aLaguangeCode	Translation language code.
aCompletionBlock	The completion block, which contains the error message if the method fails.

setPushTemplate:completion:

- (void) setPushTemplate:		(NSString *_Nullable)	aPushTemplateName
completion:		(void(^)(EMError *_Nullable aError))	aCompletionBlock

Set the push template for offline push.

Parameters

aPushTemplateName	push template name.
aCompletionBlock	The completion block, which contains the error message if the method fails.

setSilentModeForAll:completion:

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

Set global silent mode message data.

Parameters

aParam	Silent mode data parameter model ,See EMSilentModeParam.
aCompletionBlock	The completion block, which contains the error message if the method fails.

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

Set conversation silent mode message data.

Parameters

aConversationId	The conversation Id.
aConversationType	The conversation type.
aParam	Silent mode data parameter model ,See EMSilentModeParam.
aCompletionBlock	The completion block, which contains the error message if the method fails.

syncSilentModeConversationsFromServerCompletion:

- (void) syncSilentModeConversationsFromServerCompletion:

(void(^)(EMError *_Nullable error))

completionBlock

Get all conversations mute info from server.

Parameters

completionBlock

The method completes the callback called. If the method call fails, the reason for the failure will be included. If the callback EMError is empty, you can call the IEMChatManager#getAllConversations method to re-obtain the session list and refresh the UI..

updatePushDisplayName:

- (EMError *_Nullable) updatePushDisplayName:

(NSString *_Nonnull)

aDisplayName

Sets the display name of the push notification.

This is a synchronous method and blocks the current thread.

Parameters

aNickname

The display name of the push notification.

Returns

The error information if the method fails: Error.

updatePushDisplayName:completion:

- (void) updatePushDisplayName:		(NSString *_Nonnull)	aDisplayName
completion:		(void(^)(NSString *_Nullable aDisplayName, EMError *_Nullable aError))	aCompletionBlock

Sets the display name of the push notification.

This is an asynchronous method.

Parameters

aDisplayName	The display name of the push notification.
aCompletionBlock	The completion block, which contains the error message if the method fails.

updatePushDisplayStyle:

- (EMError *) updatePushDisplayStyle:

(EMPushDisplayStyle)

pushDisplayStyle

Sets the display style for the push notification.

This is a synchronous method and blocks the current thread.

Parameters

pushDisplayStyle

The display style of the push notification.

Returns

The error information if the method fails: Error.

updatePushDisplayStyle:completion:

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

Sets the display style for the push notification.

This is an asynchronous method.

Parameters

pushDisplayStyle	The display style of the push notification.
aCompletionBlock	The completion block, which contains the error message if the method fails.

Property Documentation

pushOptions

- (EMPushOptions* _Nullable) pushOptions

readnonatomicstrong

The message push configuration options.

---

The documentation for this protocol was generated from the following file:

• HyphenateChat.framework/Headers/IEMPushManager.h