Package com.slack.api.methods.request.admin.users

Class AdminUsersListRequest.AdminUsersListRequestBuilder

java.lang.Object

com.slack.api.methods.request.admin.users.AdminUsersListRequest.AdminUsersListRequestBuilder

Enclosing class:

AdminUsersListRequest

public static class AdminUsersListRequest.AdminUsersListRequestBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
AdminUsersListRequest	build()
AdminUsersListRequest.AdminUsersListRequestBuilder	cursor(String cursor)	Set cursor to next_cursor returned by the previous call to list items in the next page.
AdminUsersListRequest.AdminUsersListRequestBuilder	includeDeactivatedUserWorkspaces(Boolean includeDeactivatedUserWorkspaces)	Only applies with org token and no team_id.
AdminUsersListRequest.AdminUsersListRequestBuilder	isActive(Boolean isActive)	If true, only active users will be returned.
AdminUsersListRequest.AdminUsersListRequestBuilder	limit(Integer limit)	Limit for how many users to be retrieved per page
AdminUsersListRequest.AdminUsersListRequestBuilder	teamId(String teamId)	The ID (T1234) of the workspace.
AdminUsersListRequest.AdminUsersListRequestBuilder	token(String token)	Authentication token bearing required scopes.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

token

public AdminUsersListRequest.AdminUsersListRequestBuilder token(String token)

Authentication token bearing required scopes.

Returns:

this.

teamId

public AdminUsersListRequest.AdminUsersListRequestBuilder teamId(String teamId)

The ID (T1234) of the workspace.

Returns:

this.

includeDeactivatedUserWorkspaces

public AdminUsersListRequest.AdminUsersListRequestBuilder includeDeactivatedUserWorkspaces(Boolean includeDeactivatedUserWorkspaces)

Only applies with org token and no team_id. If true, return workspaces for a user even if they may be deactivated on them. If false, return workspaces for a user only when user is active on them. Default is false.

Returns:

this.

isActive

public AdminUsersListRequest.AdminUsersListRequestBuilder isActive(Boolean isActive)

If true, only active users will be returned. If false, only deactivated users will be returned. Default is true.

Returns:

this.

cursor

public AdminUsersListRequest.AdminUsersListRequestBuilder cursor(String cursor)

Set cursor to next_cursor returned by the previous call to list items in the next page.

Returns:

this.

limit

public AdminUsersListRequest.AdminUsersListRequestBuilder limit(Integer limit)

Limit for how many users to be retrieved per page

Returns:

this.

build

public AdminUsersListRequest build()

toString

public String toString()

Overrides:

toString in class Object