All Implemented Interfaces:

app.knock.api.core.Params
```
public final class ObjectListSubscriptionsParams
 implements Params
                    
```
List subscriptions for an object. Either list the recipients that subscribe to the provided object, or list the objects that the provided object is subscribed to. Determined by the mode query parameter.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`ObjectListSubscriptionsParams.Builder`	A builder for ObjectListSubscriptionsParams.
`public final class`	`ObjectListSubscriptionsParams.Include`
`public final class`	`ObjectListSubscriptionsParams.Mode`	Mode of the request. `recipient` to list the objects that the provided object is subscribed to, `object` to list the recipients that subscribe to the provided object.
`public final class`	`ObjectListSubscriptionsParams.Object`	A reference to a recipient object.

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>`	`objectId()`
`final Optional<String>`	`after()`	The cursor to fetch entries after.
`final Optional<String>`	`before()`	The cursor to fetch entries before.
`final Optional<List<ObjectListSubscriptionsParams.Include>>`	`include()`	Additional fields to include in the response.
`final Optional<ObjectListSubscriptionsParams.Mode>`	`mode()`	Mode of the request.
`final Optional<List<ObjectListSubscriptionsParams.Object>>`	`objects()`	Objects to filter by (only used if mode is `recipient`).
`final Optional<Long>`	`pageSize()`	The number of items per page.
`final Optional<List<RecipientReference>>`	`recipients()`	Recipients to filter by (only used if mode is `object`).
`final Headers`	`_additionalHeaders()`
`final QueryParams`	`_additionalQueryParams()`
`final ObjectListSubscriptionsParams.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 ObjectListSubscriptionsParams`	`none()`
`final static ObjectListSubscriptionsParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of ObjectListSubscriptionsParams.

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()
```
  - objectId
```
 final Optional<String> objectId()
```
  - after
```
 final Optional<String> after()
```
    The cursor to fetch entries after.
  - before
```
 final Optional<String> before()
```
    The cursor to fetch entries before.
  - include
```
 final Optional<List<ObjectListSubscriptionsParams.Include>> include()
```
    Additional fields to include in the response.
  - mode
```
 final Optional<ObjectListSubscriptionsParams.Mode> mode()
```
    Mode of the request. recipient to list the objects that the provided object is subscribed to, object to list the recipients that subscribe to the provided object.
  - objects
```
 final Optional<List<ObjectListSubscriptionsParams.Object>> objects()
```
    Objects to filter by (only used if mode is recipient).
  - pageSize
```
 final Optional<Long> pageSize()
```
    The number of items per page.
  - recipients
```
 final Optional<List<RecipientReference>> recipients()
```
    Recipients to filter by (only used if mode is object).
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
  - toBuilder
```
 final ObjectListSubscriptionsParams.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 ObjectListSubscriptionsParams none()
```
  - builder
```
 final static ObjectListSubscriptionsParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of ObjectListSubscriptionsParams.

Class ObjectListSubscriptionsParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

collection

objectId

after

before

include

mode

objects

pageSize

recipients

_additionalHeaders

_additionalQueryParams

toBuilder

_pathParam

_headers

_queryParams

equals

hashCode

toString

none

builder