SBDPublicGroupChannelListQuery Class Reference
| Inherits from | NSObject |
|---|---|
| Conforms to | NSCopying |
| Declared in | SBDPublicGroupChannelListQuery.h |
Overview
The SBDPublicGroupChannelListQuery class is a query class for getting the list of public group channels.
The instance of this class is created by createPublicGroupChannelListQuery in SBDGroupChannel class.
limit
Sets the number of channels per page.
@property (atomic) NSUInteger limitDeclared In
SBDPublicGroupChannelListQuery.h
hasNext
Shows if there is a next page
@property (atomic, readonly) BOOL hasNextDeclared In
SBDPublicGroupChannelListQuery.h
loading
Shows if the query is loading. YES if the query is loading, otherwise returns NO.
@property (atomic, readonly, getter=isLoading) BOOL loadingDeclared In
SBDPublicGroupChannelListQuery.h
includeEmptyChannel
If the value is YES, the channel list includes empty channel. The property determines if including an empty channel, or not.
@property (nonatomic) BOOL includeEmptyChannelDeclared In
SBDPublicGroupChannelListQuery.h
includeFrozenChannel
If the value is YES, the channel list includes frozen channel. Default is YES
@property (atomic) BOOL includeFrozenChannelAvailability
3.0.182
Declared In
SBDPublicGroupChannelListQuery.h
includeMemberList
If the value is YES, the channel list includes their members. The property determines including channel’s members.
@property (atomic) BOOL includeMemberListDeclared In
SBDPublicGroupChannelListQuery.h
includeMetaData
If the value is YES, the channel object of the list includes meta data property.
@property (atomic) BOOL includeMetaDataAvailability
3.0.216
Declared In
SBDPublicGroupChannelListQuery.h
order
Sets the order of the list. The order is defined in SBDPublicGroupChannelListOrder.
SBDPublicGroupChannelListOrderChronological by default.
@property (nonatomic) SBDPublicGroupChannelListOrder orderDeclared In
SBDPublicGroupChannelListQuery.h
superChannelFilter
Sets to filter super channel. SBDGroupChannelSuperChannelFilterAll by default. The property filters super group channels.
@property (nonatomic) SBDGroupChannelSuperChannelFilter superChannelFilterDeclared In
SBDPublicGroupChannelListQuery.h
publicMembershipFilter
Sets SBDGroupChannel URLs filter.
SBDGroupChannel list containing only and exactly the passed SBDGroupChannel URLs will be returned.
This does not cooperate with other filters.
@property (nonatomic) SBDPublicGroupChannelMembershipFilter publicMembershipFilterDeclared In
SBDPublicGroupChannelListQuery.h
customTypesFilter
Sets the custom types filter. The property filters channels which have one of custom types.
@property (copy, nonatomic, nullable) NSArray<NSString*> *customTypesFilterDeclared In
SBDPublicGroupChannelListQuery.h
customTypeStartsWithFilter
Sets to filter channels by custom type that starts with. The property filters custom type that starts with this string.
@property (copy, nonatomic, nullable) NSString *customTypeStartsWithFilterDeclared In
SBDPublicGroupChannelListQuery.h
channelUrlsFilter
Sets SBDGroupChannel URLs filter.
SBDGroupChannel list containing only and exactly the passed SBDGroupChannel URLs will be returned.
This does not cooperate with other filters.
@property (copy, nonatomic, nullable) NSArray<NSString*> *channelUrlsFilterDeclared In
SBDPublicGroupChannelListQuery.h
channelNameContainsFilter
Sets SBDGroupChannel names filter.
SBDGroupChannel list containing only and exactly the passed SBDGroupChannel name will be returned.
This does not cooperate with other filters.
The property filters channel name that contains this string.
@property (copy, nonatomic, nullable) NSString *channelNameContainsFilterDeclared In
SBDPublicGroupChannelListQuery.h
metaDataOrderKeyFilter
Sets a key for ordering by value in the metadata. This is valid when the order is SBDPublicGroupChannelListOrderChannelMetaDataValueAlphabetical only.
@property (copy, nonatomic, nullable) NSString *metaDataOrderKeyFilterAvailability
3.0.118
Declared In
SBDPublicGroupChannelListQuery.h
metaDataKeyFilter
Searches for group channels with metadata containing an item with the specified value as its key
@property (copy, nonatomic, nullable) NSString *metaDataKeyFilterAvailability
3.0.232
Declared In
SBDPublicGroupChannelListQuery.h
metaDataValuesFilter
Searches for group channels with metadata containing an item with the key specified by the metaDataKey
@property (copy, nonatomic, nullable) NSArray<NSString*> *metaDataValuesFilterAvailability
3.0.232
Declared In
SBDPublicGroupChannelListQuery.h
metaDataValueStartsWithFilter
Searches for group channels with metadata containing an item with the key specified by the metaDataKey and the values of that item start with the specified value
@property (copy, nonatomic, nullable) NSString *metaDataValueStartsWithFilterAvailability
3.0.232
Declared In
SBDPublicGroupChannelListQuery.h
– setMetaDataFilterWithKey:values:
The key of the meta data to use for filter.
- (void)setMetaDataFilterWithKey:(nonnull NSString *)key values:(nonnull NSArray<NSString*> *)valuesParameters
key |
The key of the meta data to use for filter. |
|---|---|
values |
The values of the meta data to use for filter. |
Declared In
SBDPublicGroupChannelListQuery.h
– setMetaDataFilterWithKey:valueStartsWith:
The key of the meta data to use for filter.
- (void)setMetaDataFilterWithKey:(nonnull NSString *)key valueStartsWith:(nonnull NSString *)valueStartsWithParameters
key |
The key of the meta data to use for filter. |
|---|---|
valueStartsWith |
The values of the meta data to use for filter. |
Declared In
SBDPublicGroupChannelListQuery.h
– loadNextPageWithCompletionHandler:
Gets the list of channels. If this method is repeatedly called, it will retrieve the following pages of the channel list.
- (void)loadNextPageWithCompletionHandler:(nullable void ( ^ ) ( NSArray<SBDGroupChannel*> *_Nullable channels , SBDError *_Nullable error ))completionHandlerParameters
completionHandler |
The handler block to execute. The |
|---|
Declared In
SBDPublicGroupChannelListQuery.h