Class BatchMarkAsInteractedParams
-
- All Implemented Interfaces:
-
app.knock.api.core.Params
public final class BatchMarkAsInteractedParams implements Params
Marks the given messages as interacted with by the user. This can include any user action on the message, with optional metadata about the specific interaction. Cannot include more than 5 key-value pairs, must not contain nested data. Read more about message engagement statuses /send-notifications/message-statuses#engagement-status.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classBatchMarkAsInteractedParams.BuilderA builder for BatchMarkAsInteractedParams.
public final classBatchMarkAsInteractedParams.BodyA request to batch mark messages as interacted with.
public final classBatchMarkAsInteractedParams.MetadataMetadata about the interaction.
-
Method Summary
Modifier and Type Method Description final List<String>messageIds()The message IDs to batch mark as interacted with. final Optional<BatchMarkAsInteractedParams.Metadata>metadata()Metadata about the interaction. final JsonField<List<String>>_messageIds()Returns the raw JSON value of messageIds. final JsonField<BatchMarkAsInteractedParams.Metadata>_metadata()Returns the raw JSON value of metadata. final Map<String, JsonValue>_additionalBodyProperties()final Headers_additionalHeaders()final QueryParams_additionalQueryParams()final BatchMarkAsInteractedParams.BuildertoBuilder()final BatchMarkAsInteractedParams.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. Booleanequals(Object other)IntegerhashCode()StringtoString()final static BatchMarkAsInteractedParams.Builderbuilder()Returns a mutable builder for constructing an instance of BatchMarkAsInteractedParams. -
-
Method Detail
-
messageIds
final List<String> messageIds()
The message IDs to batch mark as interacted with.
-
metadata
final Optional<BatchMarkAsInteractedParams.Metadata> metadata()
Metadata about the interaction.
-
_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.
-
_metadata
final JsonField<BatchMarkAsInteractedParams.Metadata> _metadata()
Returns the raw JSON value of metadata.
Unlike metadata, 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 BatchMarkAsInteractedParams.Builder toBuilder()
-
_body
final BatchMarkAsInteractedParams.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.
-
builder
final static BatchMarkAsInteractedParams.Builder builder()
Returns a mutable builder for constructing an instance of BatchMarkAsInteractedParams.
The following fields are required:
.messageIds()
-
-
-
-