<IAgoraPushManager> Protocol Reference

#import <IAgoraPushManager.h>

Inheritance diagram for <IAgoraPushManager>:

Instance Methods
(AgoraError *)	- enableOfflinePush
(AgoraError *)	- disableOfflinePushStart:end:
(AgoraError *)	- updatePushServiceForGroups:disablePush:
(void)	- updatePushServiceForGroups:disablePush:completion:
(AgoraError *)	- updatePushDisplayStyle:
(void)	- updatePushDisplayStyle:completion:
(AgoraError *)	- updatePushDisplayName:
(void)	- updatePushDisplayName:completion:
(AgoraPushOptions *)	- getPushOptionsFromServerWithError:
(void)	- getPushNotificationOptionsFromServerWithCompletion:

Properties
AgoraPushOptions *	pushOptions
NSArray *	noPushGroups

Detailed Description

IAgoraPushManager.h Push related management protocol class

Author

Hyphenate

Version

3.00

Method Documentation

- (AgoraError *) disableOfflinePushStart:		(int)	aStartHour
end:		(int)	aEndHour

Disable Apns

Synchronization method will block the current thread

Parameters

aStartHour	start time
aEndHour	end time

Returns

AgoraError error

- (AgoraError *) enableOfflinePush

Enable APNS

Synchronization method will block the current thread

Returns

AgoraError error

- (void) getPushNotificationOptionsFromServerWithCompletion:

(void(^)(AgoraPushOptions *aOptions, AgoraError *aError))

aCompletionBlock

Get Apple Push Notification Service options from the server

Parameters

aCompletionBlock

The callback of completion block

- (AgoraPushOptions *) getPushOptionsFromServerWithError:

(AgoraError *_Nullable *_Nullable)

pError

Get Apple Push Notification Service options from the server

Synchronization method will block the current thread

Parameters

pError

error

Returns

AgoraPushOptions Apple Push Notification Service options

- (AgoraError *) updatePushDisplayName:

(NSString *)

aDisplayName

Set display name for Apple Push Notification message

Synchronization method will block the current thread

Parameters

aNickname

Display name

Returns

AgoraError error

- (void) updatePushDisplayName:		(NSString *)	aDisplayName
completion:		(void(^)(NSString *aDisplayName, AgoraError *aError))	aCompletionBlock

Set display name for the push notification

Parameters

aDisplayName	Display name of push
aCompletionBlock	The callback block of completion

- (AgoraError *) updatePushDisplayStyle:

(AgoraPushDisplayStyle)

pushDisplayStyle

Set display style for Apple Push Notification message

Synchronization method will block the current thread

Parameters

pushDisplayStyle

Display style

Returns

AgoraError error

- (void) updatePushDisplayStyle:		(AgoraPushDisplayStyle)	pushDisplayStyle
completion:		(nonnull void(^)(AgoraError *_Nonnull))	aCompletionBlock

Set display style for the push notification

Parameters

pushDisplayStyle	Display style of push
aCompletionBlock	The callback block of completion

- (AgoraError *) updatePushServiceForGroups:		(NSArray *)	aGroupIds
disablePush:		(BOOL)	disable

Disable groups APNS

Synchronization method will block the current thread

Parameters

aGroupIds	group ids
disable	disable

Returns

AgoraError error

- (void) updatePushServiceForGroups:		(NSArray *)	aGroupIds
disablePush:		(BOOL)	disable
completion:		(nonnull void(^)(AgoraError *_Nonnull))	aCompletionBlock

Set display style for the push notification

Parameters

aGroupIds	group ids
disable	disable
aCompletionBlock	The callback block of completion

Property Documentation

- (NSArray*) noPushGroups

readnonatomicstrong

Groups without push notifications

- (AgoraPushOptions*) pushOptions

readnonatomicstrong

Message push configuration options

---

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

• AgoraChat.framework/Headers/IAgoraPushManager.h