AgoraChatSDK 1.0.7
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
31@protocol IAgoraChatPushManager <NSObject>
32
41@property (nonatomic, strong, readonly) AgoraChatPushOptions *_Nullable pushOptions;
42
52@property (nonatomic, strong, readonly) NSArray *noPushUIds
53EM_DEPRECATED_IOS(3_8_4, 3_9_1, "Use -getSilentModeForConversations:completion: instead");
54
65@property (nonatomic, strong, readonly) NSArray *noPushGroups
66EM_DEPRECATED_IOS(3_7_4, 3_9_1, "Use -getSilentModeForConversations:completion: instead");
67
85- (AgoraChatError *)enableOfflinePush
86EM_DEPRECATED_IOS(3_7_3, 3_9_1, "Use -setSilentModeForAll:completion: instead");
87
88
113- (AgoraChatError *)disableOfflinePushStart:(int)aStartHour end:(int)aEndHour
114EM_DEPRECATED_IOS(3_7_3, 3_9_1, "Use -setSilentModeForAll:completion: instead");
115
139- (AgoraChatError *)updatePushServiceForGroups:(NSArray *)aGroupIds
140 disablePush:(BOOL)disable
141EM_DEPRECATED_IOS(3_7_4, 3_9_1, "Use -setSilentModeForConversation:conversationType:params:completion: instead");
142
143
165- (void)updatePushServiceForGroups:(NSArray *)aGroupIds
166 disablePush:(BOOL)disable
167 completion:(nonnull void (^)(AgoraChatError * aError))aCompletionBlock
168EM_DEPRECATED_IOS(3_7_4, 3_9_1, "Use -setSilentModeForConversation:conversationType: params:completion: instead");
169
193- (AgoraChatError *)updatePushServiceForUsers:(NSArray *)aUIds
194 disablePush:(BOOL)disable
195EM_DEPRECATED_IOS(3_8_4, 3_9_1, "Use -setSilentModeForConversation:conversationType: params:completion: instead");
196
218- (void)updatePushServiceForUsers:(NSArray *)aUIds
219 disablePush:(BOOL)disable
220 completion:(nonnull void (^)(AgoraChatError * aError))aCompletionBlock
221EM_DEPRECATED_IOS(3_8_4, 3_9_1, "Use -setSilentModeForConversation:conversationType: params:completion: instead");
222
242- (AgoraChatError *)updatePushDisplayStyle:(AgoraChatPushDisplayStyle)pushDisplayStyle;
243
244
262- (void)updatePushDisplayStyle:(AgoraChatPushDisplayStyle)pushDisplayStyle
263 completion:(nonnull void (^)(AgoraChatError * aError))aCompletionBlock;
264
265
285- (AgoraChatError *_Nullable )updatePushDisplayName:(NSString * _Nonnull)aDisplayName;
286
305- (void)updatePushDisplayName:(NSString * _Nonnull)aDisplayName
306 completion:(void (^)(NSString * _Nonnull aDisplayName, AgoraChatError *aError))aCompletionBlock;
307
308
309
329- (AgoraChatPushOptions *_Nullable )getPushOptionsFromServerWithError:(AgoraChatError *_Nullable *_Nullable)pError;
330
346- (void)getPushNotificationOptionsFromServerWithCompletion:(void (^_Nullable )(AgoraChatPushOptions *_Nullable aOptions, AgoraChatError *_Nullable aError))aCompletionBlock;
347
348
363- (void)setSilentModeForAll:(AgoraChatSilentModeParam*_Nullable )aParam completion:(void (^_Nullable )(AgoraChatSilentModeResult *_Nullable aResult, AgoraChatError *_Nullable aError))aCompletionBlock;
364
376-(void)getSilentModeForAllWithCompletion:(void (^_Nullable )(AgoraChatSilentModeResult *_Nullable aResult, AgoraChatError *_Nullable aError))aCompletionBlock;
377
397- (void)setSilentModeForConversation:(NSString*_Nonnull)aConversationId
398 conversationType:(AgoraChatConversationType)aConversationType
399 params:(AgoraChatSilentModeParam*_Nullable )aParam
400 completion:(void (^_Nullable )(AgoraChatSilentModeResult *_Nullable aResult, AgoraChatError *_Nullable aError))aCompletionBlock;
418- (void)getSilentModeForConversation:(NSString*_Nonnull)aConversationId
419 conversationType:(AgoraChatConversationType)aConversationType
420 completion:(void (^_Nullable )(AgoraChatSilentModeResult *_Nullable aResult, AgoraChatError *_Nullable aError))aCompletionBlock;
421
439- (void)clearRemindTypeForConversation:(NSString*_Nonnull)aConversationId
440 conversationType:(AgoraChatConversationType)aConversationType
441 completion:(void (^_Nullable )(AgoraChatSilentModeResult *_Nullable aResult, AgoraChatError *_Nullable aError))aCompletionBlock;
442
459- (void)getSilentModeForConversations:(NSArray<AgoraChatConversation *>*_Nonnull)aConversationArray
460 completion:(void (^_Nullable )(NSDictionary<NSString*,AgoraChatSilentModeResult*>*_Nullable aResult, AgoraChatError *_Nullable aError))aCompletionBlock;
461
477- (void)setPreferredNotificationLanguage:(NSString*_Nullable)aLaguangeCode
478 completion:(void (^_Nullable )(AgoraChatError *_Nullable aError))aCompletionBlock;
491- (void)getPreferredNotificationLanguageCompletion:(void (^_Nullable )(NSString *_Nullable aLaguangeCode,AgoraChatError *_Nullable aError))aCompletionBlock;
492
508- (void)setPushTemplate:(NSString* _Nullable)aPushTemplateName
509 completion:(void (^ _Nullable)(AgoraChatError *_Nullable aError))aCompletionBlock;
522- (void)getPushTemplate:(void (^ _Nullable)(NSString *_Nullable aPushTemplateName, AgoraChatError *_Nullable aError))aCompletionBlock;
523
524
525
526@end
527
528NS_ASSUME_NONNULL_END
Definition: AgoraChatConversation.h:55
Definition: AgoraChatError.h:27
Definition: AgoraChatPushOptions.h:58
Definition: AgoraChatSilentModeParam.h:83
Definition: AgoraChatSilentModeResult.h:14
Definition: IAgoraChatPushManager.h:31
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:41