Using the getMessagesByTimestamp()
method or the getMessagesByMessageId()
method, you can retrieve a set number of previous and next messages of a specific timestamp or a message ID in a channel.
The following code shows several types of parameters that you can configure to customize a message query by using MessageListParams
. Under the MessageListParams
object, you can assign values to properties such as previousResultSize
, messageTypeFilter
, and customType
.
This table only contains properties shown in the code above. See the API reference for a complete list of properties.
Property name | Type | Description |
---|---|---|
inclusive | boolean | Determines whether to include messages sent exactly on the specified timestamp or have the matching message ID. |
previousResultSize | int | Specifies the number of messages to retrieve, which are sent previously before a specified timestamp. Note that the actual number of results may be larger than the set value when there are multiple messages with the same timestamp as the earliest message. |
nextResultSize | int | Specifies the number of messages to retrieve, which are sent later after a specified timestamp. Note that the actual number of results may be larger than the set value when there are multiple messages with the same timestamp as the latest message. |
reverse | boolean | Determines whether to sort the retrieved messages in reverse order. If set to |
messageTypeFilter | enum | Specifies the message type to filter the messages with the corresponding type. Acceptable values are |
customType | string | Specifies the custom message type to filter the messages with the corresponding custom type. |
To retrieve messages in a channel, you need to pass the MessageListParams
object as an argument to the parameter in the getMessagesByTimestamp()
method.
Parameter name | Type | Description |
---|---|---|
ts | long | Specifies the unique ID of the message to be the reference point of a retrieval. |
params | Contains a set of parameters you can use when retrieving messages. |
To retrieve a set number of previous and next messages of a specific message ID in a channel, use the getMessagesByMessageId()
method and MessageListParams
object.
Parameter name | Type | Description |
---|---|---|
messageId | long | Specifies the unique ID of the message to be the reference point of a retrieval. |
params | Contains a set of parameters you can use when retrieving messages. |