Class GuideMarkMessageAsSeenParams
-
- All Implemented Interfaces:
-
app.knock.api.core.Params
public final class GuideMarkMessageAsSeenParams implements Params
Records that a guide has been seen by a user, triggering any associated seen events.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classGuideMarkMessageAsSeenParams.BuilderA builder for GuideMarkMessageAsSeenParams.
public final classGuideMarkMessageAsSeenParams.BodyA request to trigger a guide action.
public final classGuideMarkMessageAsSeenParams.ContentThe content of the guide.
public final classGuideMarkMessageAsSeenParams.DataThe data of the guide.
public final classGuideMarkMessageAsSeenParams.MetadataThe metadata of the guide.
-
Method Summary
Modifier and Type Method Description final Optional<String>userId()final Optional<String>messageId()final StringchannelId()The unique identifier for the channel. final StringguideId()The unique identifier for the guide. final StringguideKey()The key of the guide. final StringguideStepRef()The step reference of the guide. final Optional<GuideMarkMessageAsSeenParams.Content>content()The content of the guide. final Optional<GuideMarkMessageAsSeenParams.Data>data()The data of the guide. final Optional<Boolean>isFinal()Whether the guide is final. final Optional<GuideMarkMessageAsSeenParams.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<GuideMarkMessageAsSeenParams.Content>_content()Returns the raw JSON value of content. final JsonField<GuideMarkMessageAsSeenParams.Data>_data()Returns the raw JSON value of data. final JsonField<Boolean>_isFinal()Returns the raw JSON value of isFinal. final JsonField<GuideMarkMessageAsSeenParams.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 GuideMarkMessageAsSeenParams.BuildertoBuilder()final GuideMarkMessageAsSeenParams.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. Booleanequals(Object other)IntegerhashCode()StringtoString()final static GuideMarkMessageAsSeenParams.Builderbuilder()Returns a mutable builder for constructing an instance of GuideMarkMessageAsSeenParams. -
-
Method Detail
-
guideStepRef
final String guideStepRef()
The step reference of the guide.
-
content
final Optional<GuideMarkMessageAsSeenParams.Content> content()
The content of the guide.
-
data
final Optional<GuideMarkMessageAsSeenParams.Data> data()
The data of the guide.
-
metadata
final Optional<GuideMarkMessageAsSeenParams.Metadata> metadata()
The metadata 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<GuideMarkMessageAsSeenParams.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<GuideMarkMessageAsSeenParams.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<GuideMarkMessageAsSeenParams.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 GuideMarkMessageAsSeenParams.Builder toBuilder()
-
_body
final GuideMarkMessageAsSeenParams.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.
-
builder
final static GuideMarkMessageAsSeenParams.Builder builder()
Returns a mutable builder for constructing an instance of GuideMarkMessageAsSeenParams.
The following fields are required:
.channelId() .guideId() .guideKey() .guideStepRef()
-
-
-
-