Constructor Detail

Method Detail

• id

   final Message.Builder id(String id)

  The unique identifier for the message.

• id

   final Message.Builder id(JsonField<String> id)

  Sets Builder.id to an arbitrary JSON value.

  You should usually call Builder.id with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• _typename

   final Message.Builder _typename(String _typename)

  The typename of the schema.

• _typename

   final Message.Builder _typename(JsonField<String> _typename)

  Sets Builder._typename to an arbitrary JSON value.

  You should usually call Builder._typename with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• actors

   final Message.Builder actors(List<RecipientReference> actors)

  One or more actors that are associated with this message. Note: this is a list that can contain up to 10 actors if the message is produced from a /designing-workflows/batch-function.

• actors

   final Message.Builder actors(JsonField<List<RecipientReference>> actors)

  Sets Builder.actors to an arbitrary JSON value.

  You should usually call Builder.actors with a well-typed List<RecipientReference> value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• addActor

   final Message.Builder addActor(RecipientReference actor)

  Adds a single RecipientReference to actors.

• addActor

   final Message.Builder addActor(String user)

  Alias for calling addActor with RecipientReference.ofUser(user).

• addActor

   final Message.Builder addActor(RecipientReference.ObjectReference objectReference)

  Alias for calling addActor with RecipientReference.ofObjectReference(objectReference).

• archivedAt

   final Message.Builder archivedAt(OffsetDateTime archivedAt)

  Timestamp when the message was archived.

• archivedAt

   final Message.Builder archivedAt(Optional<OffsetDateTime> archivedAt)

  Alias for calling Builder.archivedAt with archivedAt.orElse(null).

• archivedAt

   final Message.Builder archivedAt(JsonField<OffsetDateTime> archivedAt)

  Sets Builder.archivedAt to an arbitrary JSON value.

  You should usually call Builder.archivedAt with a well-typed OffsetDateTime value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• channelId

   final Message.Builder channelId(String channelId)

  The ID for the channel the message was sent through.

• channelId

   final Message.Builder channelId(JsonField<String> channelId)

  Sets Builder.channelId to an arbitrary JSON value.

  You should usually call Builder.channelId with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• clickedAt

   final Message.Builder clickedAt(OffsetDateTime clickedAt)

  Timestamp when the message was clicked.

• clickedAt

   final Message.Builder clickedAt(Optional<OffsetDateTime> clickedAt)

  Alias for calling Builder.clickedAt with clickedAt.orElse(null).

• clickedAt

   final Message.Builder clickedAt(JsonField<OffsetDateTime> clickedAt)

  Sets Builder.clickedAt to an arbitrary JSON value.

  You should usually call Builder.clickedAt with a well-typed OffsetDateTime value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• data

   final Message.Builder data(Message.Data data)

  Data associated with the message’s workflow run. Includes the workflow trigger request’s data payload merged with any additional data returned by a /designing-workflows/fetch-function. For messages produced after a /designing-workflows/batch-function, includes the payload data from the most-recent trigger request (the final activity in the batch).

• data

   final Message.Builder data(Optional<Message.Data> data)

  Alias for calling Builder.data with data.orElse(null).

• data

   final Message.Builder data(JsonField<Message.Data> data)

  Sets Builder.data to an arbitrary JSON value.

  You should usually call Builder.data with a well-typed Data value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• engagementStatuses

   final Message.Builder engagementStatuses(List<Message.EngagementStatus> engagementStatuses)

  A list of engagement statuses.

• engagementStatuses

   final Message.Builder engagementStatuses(JsonField<List<Message.EngagementStatus>> engagementStatuses)

  Sets Builder.engagementStatuses to an arbitrary JSON value.

  You should usually call Builder.engagementStatuses with a well-typed List<EngagementStatus> value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• addEngagementStatus

   final Message.Builder addEngagementStatus(Message.EngagementStatus engagementStatus)

  Adds a single EngagementStatus to engagementStatuses.

• insertedAt

   final Message.Builder insertedAt(OffsetDateTime insertedAt)

  Timestamp when the resource was created.

• insertedAt

   final Message.Builder insertedAt(JsonField<OffsetDateTime> insertedAt)

  Sets Builder.insertedAt to an arbitrary JSON value.

  You should usually call Builder.insertedAt with a well-typed OffsetDateTime value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• interactedAt

   final Message.Builder interactedAt(OffsetDateTime interactedAt)

  Timestamp when the message was interacted with.

• interactedAt

   final Message.Builder interactedAt(Optional<OffsetDateTime> interactedAt)

  Alias for calling Builder.interactedAt with interactedAt.orElse(null).

• interactedAt

   final Message.Builder interactedAt(JsonField<OffsetDateTime> interactedAt)

  Sets Builder.interactedAt to an arbitrary JSON value.

  You should usually call Builder.interactedAt with a well-typed OffsetDateTime value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• linkClickedAt

   final Message.Builder linkClickedAt(OffsetDateTime linkClickedAt)

  Timestamp when a link in the message was clicked.

• linkClickedAt

   final Message.Builder linkClickedAt(Optional<OffsetDateTime> linkClickedAt)

  Alias for calling Builder.linkClickedAt with linkClickedAt.orElse(null).

• linkClickedAt

   final Message.Builder linkClickedAt(JsonField<OffsetDateTime> linkClickedAt)

  Sets Builder.linkClickedAt to an arbitrary JSON value.

  You should usually call Builder.linkClickedAt with a well-typed OffsetDateTime value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• metadata

   final Message.Builder metadata(Message.Metadata metadata)

  The metadata associated with the message.

• metadata

   final Message.Builder metadata(Optional<Message.Metadata> metadata)

  Alias for calling Builder.metadata with metadata.orElse(null).

• metadata

   final Message.Builder metadata(JsonField<Message.Metadata> metadata)

  Sets Builder.metadata to an arbitrary JSON value.

  You should usually call Builder.metadata with a well-typed Metadata value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• readAt

   final Message.Builder readAt(OffsetDateTime readAt)

  Timestamp when the message was read.

• readAt

   final Message.Builder readAt(Optional<OffsetDateTime> readAt)

  Alias for calling Builder.readAt with readAt.orElse(null).

• readAt

   final Message.Builder readAt(JsonField<OffsetDateTime> readAt)

  Sets Builder.readAt to an arbitrary JSON value.

  You should usually call Builder.readAt with a well-typed OffsetDateTime value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• recipient

   final Message.Builder recipient(RecipientReference recipient)

  A reference to a recipient, either a user identifier (string) or an object reference (ID, collection).

• recipient

   final Message.Builder recipient(JsonField<RecipientReference> recipient)

  Sets Builder.recipient to an arbitrary JSON value.

  You should usually call Builder.recipient with a well-typed RecipientReference value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• recipient

   final Message.Builder recipient(String user)

  Alias for calling recipient with RecipientReference.ofUser(user).

• recipient

   final Message.Builder recipient(RecipientReference.ObjectReference objectReference)

  Alias for calling recipient with RecipientReference.ofObjectReference(objectReference).

• scheduledAt

   final Message.Builder scheduledAt(OffsetDateTime scheduledAt)

  Timestamp when the message was scheduled to be sent.

• scheduledAt

   final Message.Builder scheduledAt(Optional<OffsetDateTime> scheduledAt)

  Alias for calling Builder.scheduledAt with scheduledAt.orElse(null).

• scheduledAt

   final Message.Builder scheduledAt(JsonField<OffsetDateTime> scheduledAt)

  Sets Builder.scheduledAt to an arbitrary JSON value.

  You should usually call Builder.scheduledAt with a well-typed OffsetDateTime value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• seenAt

   final Message.Builder seenAt(OffsetDateTime seenAt)

  Timestamp when the message was seen.

• seenAt

   final Message.Builder seenAt(Optional<OffsetDateTime> seenAt)

  Alias for calling Builder.seenAt with seenAt.orElse(null).

• seenAt

   final Message.Builder seenAt(JsonField<OffsetDateTime> seenAt)

  Sets Builder.seenAt to an arbitrary JSON value.

  You should usually call Builder.seenAt with a well-typed OffsetDateTime value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• source

   final Message.Builder source(Message.Source source)

  The workflow that triggered the message.

• source

   final Message.Builder source(JsonField<Message.Source> source)

  Sets Builder.source to an arbitrary JSON value.

  You should usually call Builder.source with a well-typed Source value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• status

   final Message.Builder status(Message.Status status)

  The message delivery status.

• status

   final Message.Builder status(JsonField<Message.Status> status)

  Sets Builder.status to an arbitrary JSON value.

  You should usually call Builder.status with a well-typed Status value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• tenant

   final Message.Builder tenant(String tenant)

  The ID of the tenant associated with the message. Only present when a tenant is provided on a workflow trigger request.

• tenant

   final Message.Builder tenant(Optional<String> tenant)

  Alias for calling Builder.tenant with tenant.orElse(null).

• tenant

   final Message.Builder tenant(JsonField<String> tenant)

  Sets Builder.tenant to an arbitrary JSON value.

  You should usually call Builder.tenant with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• updatedAt

   final Message.Builder updatedAt(OffsetDateTime updatedAt)

  The timestamp when the resource was last updated.

• updatedAt

   final Message.Builder updatedAt(JsonField<OffsetDateTime> updatedAt)

  Sets Builder.updatedAt to an arbitrary JSON value.

  You should usually call Builder.updatedAt with a well-typed OffsetDateTime value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• workflow

  @Deprecated(message = "deprecated") final Message.Builder workflow(String workflow)

  The key of the workflow that generated the message.

• workflow

  @Deprecated(message = "deprecated") final Message.Builder workflow(Optional<String> workflow)

  Alias for calling Builder.workflow with workflow.orElse(null).

• workflow

  @Deprecated(message = "deprecated") final Message.Builder workflow(JsonField<String> workflow)

  Sets Builder.workflow to an arbitrary JSON value.

  You should usually call Builder.workflow with a well-typed String value instead. This method is primarily for setting the field to an undocumented or not yet supported value.

• additionalProperties

   final Message.Builder additionalProperties(Map<String, JsonValue> additionalProperties)

• putAdditionalProperty

   final Message.Builder putAdditionalProperty(String key, JsonValue value)

• putAllAdditionalProperties

   final Message.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)

• removeAdditionalProperty

   final Message.Builder removeAdditionalProperty(String key)

• removeAllAdditionalProperties

   final Message.Builder removeAllAdditionalProperties(Set<String> keys)

• build

   final Message build()

  Returns an immutable instance of Message.

  Further updates to this Builder will not mutate the returned instance.