<IAgoraChatPushManager>协议 参考

#import <IAgoraChatPushManager.h>

类 <IAgoraChatPushManager> 继承关系图:

构造函数
(AgoraChatError *)	- updatePushDisplayStyle:
(void)	- updatePushDisplayStyle:completion:
(AgoraChatError *_Nullable)	- updatePushDisplayName:
(void)	- updatePushDisplayName:completion:
(AgoraChatPushOptions *_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:

属性
AgoraChatPushOptions *_Nullable	pushOptions

详细描述

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

作者

Hyphenate

版本

3.00

函数文档

clearRemindTypeForConversation:conversationType:completion:

- (void) clearRemindTypeForConversation:		(NSString *_Nonnull)	aConversationId
conversationType:		(AgoraChatConversationType)	aConversationType
completion:		(void(^)(AgoraChatSilentModeResult *_Nullable aResult, AgoraChatError *_Nullable aError))	aCompletionBlock

Clear conversation remind type for push messages.

参数

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, AgoraChatError *_Nullable aError))

aCompletionBlock

Get the translation language for push messages.

参数

aCompletionBlock

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

getPushNotificationOptionsFromServerWithCompletion:

- (void) getPushNotificationOptionsFromServerWithCompletion:

(void(^)(AgoraChatPushOptions *_Nullable aOptions, AgoraChatError *_Nullable aError))

aCompletionBlock

Gets the push options from the server.

This is an asynchronous method.

参数

aCompletionBlock

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

getPushOptionsFromServerWithError:

- (AgoraChatPushOptions *_Nullable) getPushOptionsFromServerWithError:

(AgoraChatError *_Nullable *_Nullable)

pError

Gets the push options from the server.

This is a synchronous method and blocks the current thread.

参数

pError

The error information if the method fails: Error.

返回

The push options. See AgoraChatPushOptions.

getPushTemplate:

- (void) getPushTemplate:

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

aCompletionBlock

Gets the offline push template for Settings.

参数

aCompletionBlock

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

getSilentModeForAllWithCompletion:

- (void) getSilentModeForAllWithCompletion:

(void(^)(AgoraChatSilentModeResult *_Nullable aResult, AgoraChatError *_Nullable aError))

aCompletionBlock

Get global silent mode message data.

参数

aCompletionBlock

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

getSilentModeForConversation:conversationType:completion:

- (void) getSilentModeForConversation:		(NSString *_Nonnull)	aConversationId
conversationType:		(AgoraChatConversationType)	aConversationType
completion:		(void(^)(AgoraChatSilentModeResult *_Nullable aResult, AgoraChatError *_Nullable aError))	aCompletionBlock

Get conversation silent mode message data.

参数

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< AgoraChatConversation * > *_Nonnull)	aConversationArray
completion:		(void(^)(NSDictionary< NSString *, AgoraChatSilentModeResult * > *_Nullable aResult, AgoraChatError *_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

参数

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(^)(AgoraChatError *_Nullable aError))	aCompletionBlock

Set the translation language for push messages.

参数

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(^)(AgoraChatError *_Nullable aError))	aCompletionBlock

Set the push template for offline push.

参数

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

setSilentModeForAll:completion:

- (void) setSilentModeForAll:		(AgoraChatSilentModeParam *_Nullable)	aParam
completion:		(void(^)(AgoraChatSilentModeResult *_Nullable aResult, AgoraChatError *_Nullable aError))	aCompletionBlock

Set global silent mode message data.

参数

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

setSilentModeForConversation:conversationType:params:completion:

- (void) setSilentModeForConversation:		(NSString *_Nonnull)	aConversationId
conversationType:		(AgoraChatConversationType)	aConversationType
params:		(AgoraChatSilentModeParam *_Nullable)	aParam
completion:		(void(^)(AgoraChatSilentModeResult *_Nullable aResult, AgoraChatError *_Nullable aError))	aCompletionBlock

Set conversation silent mode message data.

参数

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

syncSilentModeConversationsFromServerCompletion:

- (void) syncSilentModeConversationsFromServerCompletion:

(void(^)(AgoraChatError *_Nullable error))

completionBlock

Get all conversations mute info from server.

参数

completionBlock

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

updatePushDisplayName:

- (AgoraChatError *_Nullable) updatePushDisplayName:

(NSString *_Nonnull)

aDisplayName

Sets the display name of the push notification.

This is a synchronous method and blocks the current thread.

参数

aNickname

The display name of the push notification.

返回

The error information if the method fails: Error.

updatePushDisplayName:completion:

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

Sets the display name of the push notification.

This is an asynchronous method.

参数

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

updatePushDisplayStyle:

- (AgoraChatError *) updatePushDisplayStyle:

(AgoraChatPushDisplayStyle)

pushDisplayStyle

Sets the display style for the push notification.

This is a synchronous method and blocks the current thread.

参数

pushDisplayStyle

The display style of the push notification.

返回

The error information if the method fails: Error.

updatePushDisplayStyle:completion:

- (void) updatePushDisplayStyle:		(AgoraChatPushDisplayStyle)	pushDisplayStyle
completion:		(void(^)(AgoraChatError *_Nullable aError))	aCompletionBlock

Sets the display style for the push notification.

This is an asynchronous method.

参数

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

属性说明

pushOptions

- (AgoraChatPushOptions* _Nullable) pushOptions

readnonatomicstrong

The message push configuration options.

---

该协议的文档由以下文件生成:

• AgoraChat.framework/Headers/IAgoraChatPushManager.h