java.lang.Object

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

All Implemented Interfaces:: SlackApiRequest

public class AdminConversationsSearchRequest
extends java.lang.Object
implements SlackApiRequest

https://api.slack.com/methods/admin.conversations.search

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class AdminConversationsSearchRequest.AdminConversationsSearchRequestBuilder

Method Summary

Modifier and Type	Method	Description
`static AdminConversationsSearchRequest.AdminConversationsSearchRequestBuilder`	`builder()`
`protected boolean`	`canEqual(java.lang.Object other)`
`boolean`	`equals(java.lang.Object o)`
`java.lang.String`	`getCursor()`	Set cursor to next_cursor returned by the previous call to list items in the next page.
`java.lang.Integer`	`getLimit()`	Maximum number of items to be returned.
`java.lang.String`	`getQuery()`	Name of the the channel to query by.
`java.util.List<java.lang.String>`	`getSearchChannelTypes()`	The type of channel to include or exclude in the search.
`java.lang.String`	`getSort()`	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).
`java.lang.String`	`getSortDir()`	Sort direction.
`java.util.List<java.lang.String>`	`getTeamIds()`	Comma separated string of team IDs, signifying the workspaces to search through.
`java.lang.String`	`getToken()`	Authentication token bearing required scopes.
`int`	`hashCode()`
`void`	`setCursor(java.lang.String cursor)`	Set cursor to next_cursor returned by the previous call to list items in the next page.
`void`	`setLimit(java.lang.Integer limit)`	Maximum number of items to be returned.
`void`	`setQuery(java.lang.String query)`	Name of the the channel to query by.
`void`	`setSearchChannelTypes(java.util.List<java.lang.String> searchChannelTypes)`	The type of channel to include or exclude in the search.
`void`	`setSort(java.lang.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).
`void`	`setSortDir(java.lang.String sortDir)`	Sort direction.
`void`	`setTeamIds(java.util.List<java.lang.String> teamIds)`	Comma separated string of team IDs, signifying the workspaces to search through.
`void`	`setToken(java.lang.String token)`	Authentication token bearing required scopes.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details
- builder
  
  public static AdminConversationsSearchRequest.AdminConversationsSearchRequestBuilder builder()
- getToken
  
  public java.lang.String getToken()
  
  Authentication token bearing required scopes.
  
  Specified by:
  
  getToken in interface SlackApiRequest
- getCursor
  
  public java.lang.String getCursor()
  
  Set cursor to next_cursor returned by the previous call to list items in the next page.
- getLimit
  
  public java.lang.Integer getLimit()
  
  Maximum number of items to be returned. Must be between 1 - 20 both inclusive. Default is 10. Default: 10
- getQuery
  
  public java.lang.String getQuery()
  
  Name of the the channel to query by.
- getSearchChannelTypes
  
  public java.util.List<java.lang.String> getSearchChannelTypes()
  
  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
- getSort
  
  public java.lang.String getSort()
  
  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
- getSortDir
  
  public java.lang.String getSortDir()
  
  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
- getTeamIds
  
  public java.util.List<java.lang.String> getTeamIds()
  
  Comma separated string of team IDs, signifying the workspaces to search through.
- setToken
  
  public void setToken(java.lang.String token)
  
  Authentication token bearing required scopes.
- setCursor
  
  public void setCursor(java.lang.String cursor)
  
  Set cursor to next_cursor returned by the previous call to list items in the next page.
- setLimit
  
  public void setLimit(java.lang.Integer limit)
  
  Maximum number of items to be returned. Must be between 1 - 20 both inclusive. Default is 10. Default: 10
- setQuery
  
  public void setQuery(java.lang.String query)
  
  Name of the the channel to query by.
- setSearchChannelTypes
  
  public void setSearchChannelTypes(java.util.List<java.lang.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
- setSort
  
  public void setSort(java.lang.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
- setSortDir
  
  public void setSortDir(java.lang.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
- setTeamIds
  
  public void setTeamIds(java.util.List<java.lang.String> teamIds)
  
  Comma separated string of team IDs, signifying the workspaces to search through.
- equals
  
  public boolean equals(java.lang.Object o)
  
  Overrides:
  
  equals in class java.lang.Object
- canEqual
  
  protected boolean canEqual(java.lang.Object other)
- hashCode
  
  public int hashCode()
  
  Overrides:
  
  hashCode in class java.lang.Object
- toString
  
  public java.lang.String toString()
  
  Overrides:
  
  toString in class java.lang.Object

Class AdminConversationsSearchRequest

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Details