-
Notifications
You must be signed in to change notification settings - Fork 16
/
SBDApplicationUserListQuery.h
44 lines (33 loc) · 1.54 KB
/
SBDApplicationUserListQuery.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
//
// SBDApplicationUserListQuery.h
// SendBirdSDK
//
// Created by Jed Gyeong on 11/6/18.
// Copyright © 2018 SENDBIRD.COM. All rights reserved.
//
#import "SBDUserListQuery.h"
#import "SBDUser.h"
NS_ASSUME_NONNULL_BEGIN
/// The `SBDApplicationUserListQuery` class is a query class for getting the list of all users of the current
/// application. This instance is created by `createApplicationUserListQuery` of `SBDMain`.
/// @since 3.0.120
@interface SBDApplicationUserListQuery : SBDUserListQuery <NSCopying>
/// Sets the user IDs filter.
@property (copy, nonatomic, nullable) NSArray <NSString *> *userIdsFilter;
/// The meta data key filter. This query will return users that has the meta data key and values.
/// This has to be set by `setMetaDataFilterWithKey:values:`.
@property (copy, nonatomic, readonly, nullable) NSString *metaDataKeyFilter;
/// The meta data values filter. This query will return users that has the meta data key and values.
/// This has to be set by `setMetaDataFilterWithKey:values:`.
@property (copy, nonatomic, readonly, nullable) NSArray <NSString *> *metaDataValuesFilter;
/// Filters user's nickname that starts with
/// @since 3.0.223
@property (copy, nonatomic, nullable) NSString *nicknameStartsWithFilter;
/// Sets meta data filter.
///
/// @param key The key of the meta data to use for filter.
/// @param values The values of the meta data to use for filter.
- (void)setMetaDataFilterWithKey:(nullable NSString *)key
values:(nullable NSArray<NSString *> *)values;
@end
NS_ASSUME_NONNULL_END