Package com.slack.api.methods.request.search

Class SearchMessagesRequest

java.lang.Object

com.slack.api.methods.request.search.SearchMessagesRequest

All Implemented Interfaces:

SlackApiRequest

public class SearchMessagesRequest
extends Object
implements SlackApiRequest

https://docs.slack.dev/reference/methods/search.messages

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SearchMessagesRequest.SearchMessagesRequestBuilder

Method Summary

Modifier and Type	Method	Description
static SearchMessagesRequest.SearchMessagesRequestBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Integer	getCount()
String	getCursor()
Integer	getPage()
String	getQuery()	Search query.
String	getSort()	Return matches sorted by either `score` or `timestamp`.
String	getSortDir()	Change sort direction to ascending (`asc`) or descending (`desc`).
String	getTeamId()	Required for org-wide apps.
String	getToken()	Authentication token.
int	hashCode()
boolean	isHighlight()	Pass a value of `true` to enable query highlight markers (see below).
void	setCount(Integer count)
void	setCursor(String cursor)
void	setHighlight(boolean highlight)	Pass a value of `true` to enable query highlight markers (see below).
void	setPage(Integer page)
void	setQuery(String query)	Search query.
void	setSort(String sort)	Return matches sorted by either `score` or `timestamp`.
void	setSortDir(String sortDir)	Change sort direction to ascending (`asc`) or descending (`desc`).
void	setTeamId(String teamId)	Required for org-wide apps.
void	setToken(String token)	Authentication token.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

builder

public static SearchMessagesRequest.SearchMessagesRequestBuilder builder()

getToken

public String getToken()

Authentication token. Requires scope: `search:read`

Specified by:

getToken in interface SlackApiRequest

Returns:

token string value or null

getSortDir

public String getSortDir()

Change sort direction to ascending (`asc`) or descending (`desc`).

getQuery

public String getQuery()

Search query. May contain booleans, etc.

getSort

public String getSort()

Return matches sorted by either `score` or `timestamp`.

isHighlight

public boolean isHighlight()

Pass a value of `true` to enable query highlight markers (see below).

getCursor

public String getCursor()

getCount

public Integer getCount()

getPage

public Integer getPage()

getTeamId

public String getTeamId()

Required for org-wide apps.

setToken

public void setToken(String token)

Authentication token. Requires scope: `search:read`

Specified by:

setToken in interface SlackApiRequest

setSortDir

public void setSortDir(String sortDir)

Change sort direction to ascending (`asc`) or descending (`desc`).

setQuery

public void setQuery(String query)

Search query. May contain booleans, etc.

setSort

public void setSort(String sort)

Return matches sorted by either `score` or `timestamp`.

setHighlight

public void setHighlight(boolean highlight)

Pass a value of `true` to enable query highlight markers (see below).

setCursor

public void setCursor(String cursor)

setCount

public void setCount(Integer count)

setPage

public void setPage(Integer page)

setTeamId

public void setTeamId(String teamId)

Required for org-wide apps.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object