BatchArchiveParams 1.0.0 API

All Implemented Interfaces:

app.knock.api.core.Params
```
public final class BatchArchiveParams
 implements Params
                    
```
Marks the given messages as archived. Archived messages are hidden from the default message list in the feed but can still be accessed and unarchived later.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`BatchArchiveParams.Builder`	A builder for BatchArchiveParams.
`public final class`	`BatchArchiveParams.Body`	Request to update the status of multiple messages in batch.

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 List<String>`	`messageIds()`	The message IDs to update the status of.
`final JsonField<List<String>>`	`_messageIds()`	Returns the raw JSON value of messageIds.
`final Map<String, JsonValue>`	`_additionalBodyProperties()`
`final Headers`	`_additionalHeaders()`
`final QueryParams`	`_additionalQueryParams()`
`final BatchArchiveParams.Builder`	`toBuilder()`
`final BatchArchiveParams.Body`	`_body()`
`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 BatchArchiveParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of BatchArchiveParams.

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

- Constructor Detail
- Method Detail
  - messageIds
```
 final List<String> messageIds()
```
    The message IDs to update the status of.
  - _messageIds
```
 final JsonField<List<String>> _messageIds()
```
    Returns the raw JSON value of messageIds.
    Unlike messageIds, this method doesn't throw if the JSON field has an unexpected type.
  - _additionalBodyProperties
```
 final Map<String, JsonValue> _additionalBodyProperties()
```
  - _additionalHeaders
```
 final Headers _additionalHeaders()
```
  - _additionalQueryParams
```
 final QueryParams _additionalQueryParams()
```
  - toBuilder
```
 final BatchArchiveParams.Builder toBuilder()
```
  - _body
```
 final BatchArchiveParams.Body _body()
```
  - _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()
```
  - builder
```
 final static BatchArchiveParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of BatchArchiveParams.
    The following fields are required:
    .messageIds()