UsersRequestBuilder class
Builder class for UsersRequest.
Android Reference: UsersRequest.UsersRequestBuilder
Constructors
- UsersRequestBuilder()
-
Default constructor for
UsersRequestBuilder.
Properties
- friendsOnly ↔ bool
-
Flag to include only friends.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- hideBlockedUsers ↔ bool
-
Flag to hide blocked users.
getter/setter pair
- limit ↔ int
-
Number of results to limit the query.
getter/setter pair
- page ← int
-
Sets the page number for pagination.
Android Reference:
setPage(int page)- adds PAGE_OFFSET internallyno getter - role ↔ String?
-
Role of the users (deprecated).
getter/setter pair
-
roles
↔ List<
String> ? -
Roles for filtering.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
searchIn
↔ List<
String> ? -
Search in specific fields.
getter/setter pair
- searchKeyword ↔ String?
-
Keyword for searching.
getter/setter pair
- sortBy ↔ String?
-
Sort by field.
getter/setter pair
- sortByOrder ↔ String?
-
Sort order.
getter/setter pair
-
Tags for filtering.
getter/setter pair
-
uids
↔ List<
String> ? -
User ids for filtering.
getter/setter pair
- userStatus ↔ String?
-
Status of the users.
getter/setter pair
- withTags ↔ bool
-
Flag to include tags.
getter/setter pair
Methods
-
build(
) → UsersRequest -
Builds and returns an
UsersRequestobject. -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
setFriendsOnly(
bool friendsOnly) → UsersRequestBuilder -
Sets the flag to include only friends.
Android Reference:
UsersRequestBuilder.setFriendsOnly(bool) -
setHideBlockedUsers(
bool hideBlockedUsers) → UsersRequestBuilder -
Sets the flag to hide blocked users.
Android Reference:
UsersRequestBuilder.setHideBlockedUsers(bool) -
setLimit(
int limit) → UsersRequestBuilder -
Sets the limit for users.
Android Reference:
UsersRequestBuilder.setLimit(int limit) -
setPage(
int page) → UsersRequestBuilder -
Sets the page number for pagination (fluent).
Android Reference:
UsersRequestBuilder.setPage(int page) -
setRole(
String role) → UsersRequestBuilder -
Sets the role filter (deprecated, use setRoles instead).
Android Reference:
UsersRequestBuilder.setRole(String) -
setRoles(
List< String> roles) → UsersRequestBuilder -
Sets the roles for filtering.
Android Reference:
UsersRequestBuilder.setRoles(List<String>) -
setSearchIn(
List< String> searchIn) → UsersRequestBuilder -
Sets the fields to search in.
Android Reference:
UsersRequestBuilder.setSearchIn(List<String>) -
setSearchKeyword(
String searchKeyword) → UsersRequestBuilder -
Sets the search keyword.
Android Reference:
UsersRequestBuilder.setSearchKeyword(String) -
setSortBy(
String sortBy) → UsersRequestBuilder -
Sets the sort by field.
Android Reference:
UsersRequestBuilder.setSortBy(String) -
setSortByOrder(
String sortByOrder) → UsersRequestBuilder -
Sets the sort order.
Android Reference:
UsersRequestBuilder.setSortByOrder(String) -
setTags(
List< String> tags) → UsersRequestBuilder -
Sets the tags for filtering.
Android Reference:
UsersRequestBuilder.setTags(List<String>) -
setUIDs(
List< String> uids) → UsersRequestBuilder -
Sets the UIDs for filtering.
Android Reference:
UsersRequestBuilder.setUIDs(List<String>) -
setUserStatus(
String userStatus) → UsersRequestBuilder -
Sets the user status filter.
Android Reference:
UsersRequestBuilder.setUserStatus(String) -
setWithTags(
bool withTags) → UsersRequestBuilder -
Sets the flag to include tags.
Android Reference:
UsersRequestBuilder.setWithTags(bool) -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited