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

Class AdminConversationsSearchRequest.AdminConversationsSearchRequestBuilder

java.lang.Object

com.slack.api.methods.request.admin.conversations.AdminConversationsSearchRequest.AdminConversationsSearchRequestBuilder

Enclosing class:

AdminConversationsSearchRequest

public static class AdminConversationsSearchRequest.AdminConversationsSearchRequestBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
AdminConversationsSearchRequest	build()
AdminConversationsSearchRequest.AdminConversationsSearchRequestBuilder	cursor(String cursor)	Set cursor to next_cursor returned by the previous call to list items in the next page.
AdminConversationsSearchRequest.AdminConversationsSearchRequestBuilder	limit(Integer limit)	Maximum number of items to be returned.
AdminConversationsSearchRequest.AdminConversationsSearchRequestBuilder	query(String query)	Name of the the channel to query by.
AdminConversationsSearchRequest.AdminConversationsSearchRequestBuilder	searchChannelTypes(List<String> searchChannelTypes)	The type of channel to include or exclude in the search.
AdminConversationsSearchRequest.AdminConversationsSearchRequestBuilder	sort(String sort)	Possible values are relevant (search ranking based on what we think is closest), name (alphabetical), member_count (number of users in the channel), and created (date channel was created).
AdminConversationsSearchRequest.AdminConversationsSearchRequestBuilder	sortDir(String sortDir)	Sort direction.
AdminConversationsSearchRequest.AdminConversationsSearchRequestBuilder	teamIds(List<String> teamIds)	Comma separated string of team IDs, signifying the workspaces to search through.
AdminConversationsSearchRequest.AdminConversationsSearchRequestBuilder	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 AdminConversationsSearchRequest.AdminConversationsSearchRequestBuilder token(String token)

Authentication token bearing required scopes.

Returns:

this.

cursor

public AdminConversationsSearchRequest.AdminConversationsSearchRequestBuilder cursor(String cursor)

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

Returns:

this.

limit

public AdminConversationsSearchRequest.AdminConversationsSearchRequestBuilder limit(Integer limit)

Maximum number of items to be returned. Must be between 1 - 20 both inclusive. Default is 10. Default: 10

Returns:

this.

query

public AdminConversationsSearchRequest.AdminConversationsSearchRequestBuilder query(String query)

Name of the the channel to query by.

Returns:

this.

searchChannelTypes

public AdminConversationsSearchRequest.AdminConversationsSearchRequestBuilder searchChannelTypes(List<String> searchChannelTypes)

The type of channel to include or exclude in the search. For example private will search private channels, while private_exclude will exclude them. For a full list of types, check the Types section. https://api.slack.com/methods/admin.conversations.search#types

Returns:

this.

sort

public AdminConversationsSearchRequest.AdminConversationsSearchRequestBuilder sort(String sort)

Possible values are relevant (search ranking based on what we think is closest), name (alphabetical), member_count (number of users in the channel), and created (date channel was created). You can optionally pair this with the sort_dir arg to change how it is sorted Default: member_count

Returns:

this.

sortDir

public AdminConversationsSearchRequest.AdminConversationsSearchRequestBuilder sortDir(String sortDir)

Sort direction. Possible values are asc for ascending order like (1, 2, 3) or (a, b, c), and desc for descending order like (3, 2, 1) or (c, b, a) Default: desc

Returns:

this.

teamIds

public AdminConversationsSearchRequest.AdminConversationsSearchRequestBuilder teamIds(List<String> teamIds)

Comma separated string of team IDs, signifying the workspaces to search through.

Returns:

this.

build

public AdminConversationsSearchRequest build()

toString

public String toString()

Overrides:

toString in class Object