All Implemented Interfaces:

app.knock.api.core.Params
```
public final class ObjectListMessagesParams
 implements Params
                    
```
Returns a paginated list of messages for a specific object in the given collection. Allows filtering by message status and provides various sorting options.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`ObjectListMessagesParams.Builder`	A builder for ObjectListMessagesParams.
`public final class`	`ObjectListMessagesParams.EngagementStatus`
`public final class`	`ObjectListMessagesParams.InsertedAt`
`public final class`	`ObjectListMessagesParams.Status`

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Optional<String>`	`collection()`
`final Optional<String>`	`id()`
`final Optional<String>`	`after()`	The cursor to fetch entries after.
`final Optional<String>`	`before()`	The cursor to fetch entries before.
`final Optional<String>`	`channelId()`	Limits the results to items with the corresponding channel ID.
`final Optional<List<ObjectListMessagesParams.EngagementStatus>>`	`engagementStatus()`	Limits the results to messages with the given engagement status.
`final Optional<ObjectListMessagesParams.InsertedAt>`	`insertedAt()`
`final Optional<List<String>>`	`messageIds()`	Limits the results to only the message IDs given (max 50).
`final Optional<Long>`	`pageSize()`	The number of items per page.
`final Optional<String>`	`source()`	Limits the results to messages triggered by the given workflow key.
`final Optional<List<ObjectListMessagesParams.Status>>`	`status()`	Limits the results to messages with the given delivery status.
`final Optional<String>`	`tenant()`	Limits the results to items with the corresponding tenant.
`final Optional<String>`	`triggerData()`	Limits the results to only messages that were generated with the given data.
`final Optional<List<String>>`	`workflowCategories()`	Limits the results to messages related to any of the provided categories.
`final Optional<String>`	`workflowRecipientRunId()`	Limits the results to messages for a specific recipient's workflow run.
`final Optional<String>`	`workflowRunId()`	Limits the results to messages associated with the top-level workflow run ID returned by the workflow trigger request.
`final Headers`	`_additionalHeaders()`
`final QueryParams`	`_additionalQueryParams()`
`final ObjectListMessagesParams.Builder`	`toBuilder()`
`final String`	`_pathParam(Integer index)`
`Headers`	`_headers()`	The full set of headers in the parameters, including both fixed and additional headers.
`QueryParams`	`_queryParams()`	The full set of query params in the parameters, including both fixed and additional query params.
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static ObjectListMessagesParams`	`none()`
`final static ObjectListMessagesParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of ObjectListMessagesParams.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - collection
```
 final Optional<String> collection()
```
  - id
```
 final Optional<String> id()
```
  - after
```
 final Optional<String> after()
```
    The cursor to fetch entries after.
  - before
```
 final Optional<String> before()
```
    The cursor to fetch entries before.
  - channelId
```
 final Optional<String> channelId()
```
    Limits the results to items with the corresponding channel ID.
  - engagementStatus
```
 final Optional<List<ObjectListMessagesParams.EngagementStatus>> engagementStatus()
```
    Limits the results to messages with the given engagement status.
  - insertedAt
```
 final Optional<ObjectListMessagesParams.InsertedAt> insertedAt()
```
  - messageIds
```
 final Optional<List<String>> messageIds()
```
    Limits the results to only the message IDs given (max 50). Note: when using this option, the results will be subject to any other filters applied to the query.
  - pageSize
```
 final Optional<Long> pageSize()
```
    The number of items per page.
  - source
```
 final Optional<String> source()
```
    Limits the results to messages triggered by the given workflow key.
  - status
```
 final Optional<List<ObjectListMessagesParams.Status>> status()
```
    Limits the results to messages with the given delivery status.
  - tenant
```
 final Optional<String> tenant()
```
    Limits the results to items with the corresponding tenant.
  - triggerData
```
 final Optional<String> triggerData()
```
    Limits the results to only messages that were generated with the given data. See /api-reference/overview/trigger-data-filtering for more information.
  - workflowCategories
```
 final Optional<List<String>> workflowCategories()
```
    Limits the results to messages related to any of the provided categories.
  - workflowRecipientRunId
```
 final Optional<String> workflowRecipientRunId()
```
    Limits the results to messages for a specific recipient's workflow run.
  - workflowRunId
```
 final Optional<String> workflowRunId()
```
    Limits the results to messages associated with the top-level workflow run ID returned by the workflow trigger request.
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
  - toBuilder
```
 final ObjectListMessagesParams.Builder toBuilder()
```
  - _pathParam
```
 final String _pathParam(Integer index)
```
  - _headers
```
 Headers _headers()
```
    The full set of headers in the parameters, including both fixed and additional headers.
  - _queryParams
```
 QueryParams _queryParams()
```
    The full set of query params in the parameters, including both fixed and additional query params.
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - none
```
 final static ObjectListMessagesParams none()
```
  - builder
```
 final static ObjectListMessagesParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of ObjectListMessagesParams.

Class ObjectListMessagesParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

collection

id

after

before

channelId

engagementStatus

insertedAt

messageIds

pageSize

source

status

tenant

triggerData

workflowCategories

workflowRecipientRunId

workflowRunId

_additionalHeaders

_additionalQueryParams

toBuilder

_pathParam

_headers

_queryParams

equals

hashCode

toString

none

builder