Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UsersRequestBuilder

Hierarchy

  • UsersRequestBuilder

Index

Constructors

Methods

Constructors

constructor

Methods

build

  • This method will return an object of the UsersRequest class.

    Returns UsersRequest

friendsOnly

hideBlockedUsers

  • Method to hide blocked users.

    Parameters

    • hideBlockedUsers: boolean

    Returns UsersRequestBuilder

setLimit

  • A method to set limit for the number of Users returned in a single iteration. A maximum of 100 users can fetched in a single iteration.

    Parameters

    • limit: number

    Returns UsersRequestBuilder

setRole

  • A method to get the users with the specified role.

    Parameters

    • role: string

    Returns UsersRequestBuilder

setRoles

  • A method to get the users with the specified roles.

    Parameters

    • roles: String[]

    Returns UsersRequestBuilder

setSearchKeyword

  • A method to set the search string based on which the users are to be fetched.

    Parameters

    • searchKeyword: string

    Returns UsersRequestBuilder

setStatus

  • A method to get the users belonging to a specific status.

    Parameters

    • status: string

    Returns UsersRequestBuilder

setTags

  • A method to get the users with the specified tags.

    Parameters

    • tags: String[]

    Returns UsersRequestBuilder

setUIDs

  • A method to get the users with the specified UIDs.

    Parameters

    • uids: String[]

    Returns UsersRequestBuilder

withTags

  • A method to get the tags along with the other details of the users.

    Parameters

    • withTags: boolean

    Returns UsersRequestBuilder