AgoraChatSDK 1.3.1
IAgoraChatPushManager.h
1//
2// IAgoraChatPushManager.h
3// HyphenateSDK
4//
5// Created by 杜洁鹏 on 2020/10/26.
6// Copyright © 2020 easemob.com. All rights reserved.
7//
8
9#import <Foundation/Foundation.h>
10#import "AgoraChatCommonDefs.h"
11#import "AgoraChatPushOptions.h"
12#import "AgoraChatError.h"
13#import "AgoraChatCursorResult.h"
14#import "AgoraChatSilentModeResult.h"
15
16NS_ASSUME_NONNULL_BEGIN
25@protocol IAgoraChatPushManager <NSObject>
26
32@property (nonatomic, strong, readonly) AgoraChatPushOptions *_Nullable pushOptions;
33
39@property (nonatomic, strong, readonly) NSArray *noPushUIds
40EM_DEPRECATED_IOS(3_8_4, 3_9_1, "Use -getSilentModeForConversations:completion: instead");
41
47@property (nonatomic, strong, readonly) NSArray *noPushGroups
48EM_DEPRECATED_IOS(3_7_4, 3_9_1, "Use -getSilentModeForConversations:completion: instead");
49
59- (AgoraChatError *)enableOfflinePush
60EM_DEPRECATED_IOS(3_7_3, 3_9_1, "Use -setSilentModeForAll:completion: instead");
61
62
76- (AgoraChatError *)disableOfflinePushStart:(int)aStartHour end:(int)aEndHour
77EM_DEPRECATED_IOS(3_7_3, 3_9_1, "Use -setSilentModeForAll:completion: instead");
78
91- (AgoraChatError *)updatePushServiceForGroups:(NSArray *)aGroupIds
92 disablePush:(BOOL)disable
93EM_DEPRECATED_IOS(3_7_4, 3_9_1, "Use -setSilentModeForConversation:conversationType:params:completion: instead");
94
95
107- (void)updatePushServiceForGroups:(NSArray *)aGroupIds
108 disablePush:(BOOL)disable
109 completion:(nonnull void (^)(AgoraChatError * aError))aCompletionBlock
110EM_DEPRECATED_IOS(3_7_4, 3_9_1, "Use -setSilentModeForConversation:conversationType: params:completion: instead");
111
124- (AgoraChatError *)updatePushServiceForUsers:(NSArray *)aUIds
125 disablePush:(BOOL)disable
126EM_DEPRECATED_IOS(3_8_4, 3_9_1, "Use -setSilentModeForConversation:conversationType: params:completion: instead");
127
139- (void)updatePushServiceForUsers:(NSArray *)aUIds
140 disablePush:(BOOL)disable
141 completion:(nonnull void (^)(AgoraChatError * aError))aCompletionBlock
142EM_DEPRECATED_IOS(3_8_4, 3_9_1, "Use -setSilentModeForConversation:conversationType: params:completion: instead");
143
154- (AgoraChatError *)updatePushDisplayStyle:(AgoraChatPushDisplayStyle)pushDisplayStyle;
155
156
166- (void)updatePushDisplayStyle:(AgoraChatPushDisplayStyle)pushDisplayStyle
167 completion:(void (^ _Nullable)(AgoraChatError * _Nullable aError))aCompletionBlock;
168
169
180- (AgoraChatError *_Nullable )updatePushDisplayName:(NSString * _Nonnull)aDisplayName;
181
192- (void)updatePushDisplayName:(NSString * _Nonnull)aDisplayName
193 completion:(void (^_Nullable)(NSString * _Nullable aDisplayName, AgoraChatError * _Nullable aError))aCompletionBlock;
194
195
196
207- (AgoraChatPushOptions *_Nullable )getPushOptionsFromServerWithError:(AgoraChatError *_Nullable *_Nullable)pError;
208
217- (void)getPushNotificationOptionsFromServerWithCompletion:(void (^_Nullable )(AgoraChatPushOptions *_Nullable aOptions, AgoraChatError *_Nullable aError))aCompletionBlock;
218
219
228- (void)setSilentModeForAll:(AgoraChatSilentModeParam*_Nullable )aParam completion:(void (^_Nullable )(AgoraChatSilentModeResult *_Nullable aResult, AgoraChatError *_Nullable aError))aCompletionBlock;
229
236-(void)getSilentModeForAllWithCompletion:(void (^_Nullable )(AgoraChatSilentModeResult *_Nullable aResult, AgoraChatError *_Nullable aError))aCompletionBlock;
237
244- (void)syncSilentModeConversationsFromServerCompletion:(void (^_Nullable )(AgoraChatError *_Nullable error))completionBlock;
245
246
247
258- (void)setSilentModeForConversation:(NSString*_Nonnull)aConversationId
259 conversationType:(AgoraChatConversationType)aConversationType
260 params:(AgoraChatSilentModeParam*_Nullable )aParam
261 completion:(void (^_Nullable )(AgoraChatSilentModeResult *_Nullable aResult, AgoraChatError *_Nullable aError))aCompletionBlock;
272- (void)getSilentModeForConversation:(NSString*_Nonnull)aConversationId
273 conversationType:(AgoraChatConversationType)aConversationType
274 completion:(void (^_Nullable )(AgoraChatSilentModeResult *_Nullable aResult, AgoraChatError *_Nullable aError))aCompletionBlock;
275
286- (void)clearRemindTypeForConversation:(NSString*_Nonnull)aConversationId
287 conversationType:(AgoraChatConversationType)aConversationType
288 completion:(void (^_Nullable )(AgoraChatSilentModeResult *_Nullable aResult, AgoraChatError *_Nullable aError))aCompletionBlock;
289
299- (void)getSilentModeForConversations:(NSArray<AgoraChatConversation *>*_Nonnull)aConversationArray
300 completion:(void (^_Nullable )(NSDictionary<NSString*,AgoraChatSilentModeResult*>*_Nullable aResult, AgoraChatError *_Nullable aError))aCompletionBlock;
301
311- (void)setPreferredNotificationLanguage:(NSString*_Nullable)aLaguangeCode
312 completion:(void (^_Nullable )(AgoraChatError *_Nullable aError))aCompletionBlock;
321- (void)getPreferredNotificationLanguageCompletion:(void (^_Nullable )(NSString *_Nullable aLaguangeCode,AgoraChatError *_Nullable aError))aCompletionBlock;
322
332- (void)setPushTemplate:(NSString* _Nullable)aPushTemplateName
333 completion:(void (^ _Nullable)(AgoraChatError *_Nullable aError))aCompletionBlock;
342- (void)getPushTemplate:(void (^ _Nullable)(NSString *_Nullable aPushTemplateName, AgoraChatError *_Nullable aError))aCompletionBlock;
343
344
345
346@end
347
348NS_ASSUME_NONNULL_END
Definition: AgoraChatConversation.h:87
Definition: AgoraChatError.h:18
Definition: AgoraChatPushOptions.h:40
Definition: AgoraChatSilentModeParam.h:63
Definition: AgoraChatSilentModeResult.h:18
Definition: IAgoraChatPushManager.h:25
3_7_3, 3_9_1, "Use -setSilentModeForAll:completion: instead" EM_DEPRECATED_IOS()
NSArray *noPushUIds EM_DEPRECATED_IOS(3_8_4, 3_9_1, "Use -getSilentModeForConversations:completion: instead")
AgoraChatPushOptions *_Nullable pushOptions
Definition: IAgoraChatPushManager.h:32