ApplicationUserListQuery

@objc(SBDApplicationUserListQuery)
public final class ApplicationUserListQuery : NSObject, Queryable, UserListQuery

The ApplicationUserListQuery class is a query class for getting the list of all users of the current application.

This instance is created by createApplicationUserListQuery() of SendbirdChat.

Since

3.0.120

  • indicates there are more data to fetch

    Declaration

    Swift

    public internal(set) var hasNext: Bool { get }

  • Indicates the query is currently loading or not

    Declaration

    Swift

    public internal(set) var isLoading: Bool { get }

  • Fetches next page

    Declaration

    Swift

    public func loadNextPage(completionHandler: @escaping UserListHandler)

    Parameters

    completionHandler

    completion handler

  • Copies this object

    Declaration

    Swift

    public func copy(with zone: NSZone? = nil) -> Any

    Parameters

    zone

    optional NSZone

    Return Value

    ApplicationUserListQuery instance

Params Bridge

  • Specifies the number of results to return per call. (Default: 20)

    Declaration

    Swift

    @objc
public var limit: UInt { get }

  • Sets the user IDs filter.

    Declaration

    Swift

    @objc
public var userIdsFilter: [String]? { get }

  • 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:.

    Declaration

    Swift

    @objc
public var metaDataKeyFilter: String? { get }

  • 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:.

    Declaration

    Swift

    @objc
public var metaDataValuesFilter: [String]? { get }

  • Filters user’s nickname that starts with

    Since

    3.0.223

    Declaration

    Swift

    @objc
public var nicknameStartsWithFilter: String? { get }