ApplicationUserListQueryParams

@objc(SBDApplicationUserListQueryParams)
public final class ApplicationUserListQueryParams : NSObject
extension ApplicationUserListQueryParams: NSCopying

Undocumented

  • Sets the user IDs filter.

    Declaration

    Swift

    @objc
public var userIdsFilter: [String]?

  • Filters user’s nickname that starts with.

    Since

    3.0.223

    Declaration

    Swift

    @objc
public var nicknameStartsWithFilter: String?

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

    Declaration

    Swift

    @objc
public var limit: UInt

  • 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 private(set) 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 private(set) var metaDataValuesFilter: [String]? { get }

  • Default constructor.

    Declaration

    Swift

    public override init()

  • Initializes and returns a newly allocated params object that mutated through builder closure.

    Declaration

    Swift

    @objc
public init(builder: (ApplicationUserListQueryParams) -> Void)

    Parameters

    builder

    The builder closure.

    Return Value

    An initialized params object.

  • Sets meta data filter.

    Declaration

    Swift

    @objc
public func setMetaDataFilter(key: String?, values: [String]?)

    Parameters

    key

    The key of the meta data to use for filter.
    values

    The values of the meta data to use for filter.

Equatable

  • Undocumented

    Declaration

    Swift

    public override func isEqual(_ object: Any?) -> Bool

NSCopying

  • Undocumented

    Declaration

    Swift

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