All Implemented Interfaces:

app.knock.api.core.Params
```
public final class GuideMarkMessageAsArchivedParams
 implements Params
                    
```
Records that a guide has been archived by a user, triggering any associated archived events.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`GuideMarkMessageAsArchivedParams.Builder`	A builder for GuideMarkMessageAsArchivedParams.
`public final class`	`GuideMarkMessageAsArchivedParams.Body`	A request to trigger a guide action.
`public final class`	`GuideMarkMessageAsArchivedParams.Content`	The content of the guide.
`public final class`	`GuideMarkMessageAsArchivedParams.Data`	The data of the guide.
`public final class`	`GuideMarkMessageAsArchivedParams.Metadata`	The metadata of the guide.

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>`	`userId()`
`final Optional<String>`	`messageId()`
`final String`	`channelId()`	The unique identifier for the channel.
`final String`	`guideId()`	The unique identifier for the guide.
`final String`	`guideKey()`	The key of the guide.
`final String`	`guideStepRef()`	The step reference of the guide.
`final Optional<GuideMarkMessageAsArchivedParams.Content>`	`content()`	The content of the guide.
`final Optional<GuideMarkMessageAsArchivedParams.Data>`	`data()`	The data of the guide.
`final Optional<Boolean>`	`isFinal()`	Whether the guide is final.
`final Optional<GuideMarkMessageAsArchivedParams.Metadata>`	`metadata()`	The metadata of the guide.
`final Optional<String>`	`tenant()`	The tenant ID of the guide.
`final JsonField<String>`	`_channelId()`	Returns the raw JSON value of channelId.
`final JsonField<String>`	`_guideId()`	Returns the raw JSON value of guideId.
`final JsonField<String>`	`_guideKey()`	Returns the raw JSON value of guideKey.
`final JsonField<String>`	`_guideStepRef()`	Returns the raw JSON value of guideStepRef.
`final JsonField<GuideMarkMessageAsArchivedParams.Content>`	`_content()`	Returns the raw JSON value of content.
`final JsonField<GuideMarkMessageAsArchivedParams.Data>`	`_data()`	Returns the raw JSON value of data.
`final JsonField<Boolean>`	`_isFinal()`	Returns the raw JSON value of isFinal.
`final JsonField<GuideMarkMessageAsArchivedParams.Metadata>`	`_metadata()`	Returns the raw JSON value of metadata.
`final JsonField<String>`	`_tenant()`	Returns the raw JSON value of tenant.
`final Map<String, JsonValue>`	`_additionalBodyProperties()`
`final Headers`	`_additionalHeaders()`
`final QueryParams`	`_additionalQueryParams()`
`final GuideMarkMessageAsArchivedParams.Builder`	`toBuilder()`
`final GuideMarkMessageAsArchivedParams.Body`	`_body()`
`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 GuideMarkMessageAsArchivedParams.Builder`	`builder()`	Returns a mutable builder for constructing an instance of GuideMarkMessageAsArchivedParams.

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

- Constructor Detail
- Method Detail
  - userId
```
 final Optional<String> userId()
```
  - messageId
```
 final Optional<String> messageId()
```
  - channelId
```
 final String channelId()
```
    The unique identifier for the channel.
  - guideId
```
 final String guideId()
```
    The unique identifier for the guide.
  - guideKey
```
 final String guideKey()
```
    The key of the guide.
  - guideStepRef
```
 final String guideStepRef()
```
    The step reference of the guide.
  - content
```
 final Optional<GuideMarkMessageAsArchivedParams.Content> content()
```
    The content of the guide.
  - data
```
 final Optional<GuideMarkMessageAsArchivedParams.Data> data()
```
    The data of the guide.
  - isFinal
```
 final Optional<Boolean> isFinal()
```
    Whether the guide is final.
  - metadata
```
 final Optional<GuideMarkMessageAsArchivedParams.Metadata> metadata()
```
    The metadata of the guide.
  - tenant
```
 final Optional<String> tenant()
```
    The tenant ID of the guide.
  - _channelId
```
 final JsonField<String> _channelId()
```
    Returns the raw JSON value of channelId.
    Unlike channelId, this method doesn't throw if the JSON field has an unexpected type.
  - _guideId
```
 final JsonField<String> _guideId()
```
    Returns the raw JSON value of guideId.
    Unlike guideId, this method doesn't throw if the JSON field has an unexpected type.
  - _guideKey
```
 final JsonField<String> _guideKey()
```
    Returns the raw JSON value of guideKey.
    Unlike guideKey, this method doesn't throw if the JSON field has an unexpected type.
  - _guideStepRef
```
 final JsonField<String> _guideStepRef()
```
    Returns the raw JSON value of guideStepRef.
    Unlike guideStepRef, this method doesn't throw if the JSON field has an unexpected type.
  - _content
```
 final JsonField<GuideMarkMessageAsArchivedParams.Content> _content()
```
    Returns the raw JSON value of content.
    Unlike content, this method doesn't throw if the JSON field has an unexpected type.
  - _data
```
 final JsonField<GuideMarkMessageAsArchivedParams.Data> _data()
```
    Returns the raw JSON value of data.
    Unlike data, this method doesn't throw if the JSON field has an unexpected type.
  - _isFinal
```
 final JsonField<Boolean> _isFinal()
```
    Returns the raw JSON value of isFinal.
    Unlike isFinal, this method doesn't throw if the JSON field has an unexpected type.
  - _metadata
```
 final JsonField<GuideMarkMessageAsArchivedParams.Metadata> _metadata()
```
    Returns the raw JSON value of metadata.
    Unlike metadata, this method doesn't throw if the JSON field has an unexpected type.
  - _tenant
```
 final JsonField<String> _tenant()
```
    Returns the raw JSON value of tenant.
    Unlike tenant, 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 GuideMarkMessageAsArchivedParams.Builder toBuilder()
```
  - _body
```
 final GuideMarkMessageAsArchivedParams.Body _body()
```
  - _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()
```
  - builder
```
 final static GuideMarkMessageAsArchivedParams.Builder builder()
```
    Returns a mutable builder for constructing an instance of GuideMarkMessageAsArchivedParams.
    The following fields are required:
    .channelId() .guideId() .guideKey() .guideStepRef()

Class GuideMarkMessageAsArchivedParams

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

userId

messageId

channelId

guideId

guideKey

guideStepRef

content

data

isFinal

metadata

tenant

_channelId

_guideId

_guideKey

_guideStepRef

_content

_data

_isFinal

_metadata

_tenant

_additionalBodyProperties

_additionalHeaders

_additionalQueryParams

toBuilder

_body

_pathParam

_headers

_queryParams

equals

hashCode

toString

builder