Interface EngagementContextDetails.Builder

All Superinterfaces:
Buildable, CopyableBuilder<EngagementContextDetails.Builder,EngagementContextDetails>, SdkBuilder<EngagementContextDetails.Builder,EngagementContextDetails>, SdkPojo
Enclosing class:
EngagementContextDetails
@Mutable @NotThreadSafe public static interface EngagementContextDetails.Builder extends SdkPojo, CopyableBuilder<EngagementContextDetails.Builder,EngagementContextDetails>

  • Method Details

    • id

      EngagementContextDetails.Builder id(String id)

      The unique identifier of the engagement context. This ID is used to reference and manage the specific context within the engagement.

      Parameters:
      id - The unique identifier of the engagement context. This ID is used to reference and manage the specific context within the engagement.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • type

      EngagementContextDetails.Builder type(String type)

      Specifies the type of Engagement context. Valid values are "CustomerProject" or "Document", indicating whether the context relates to a customer project or a document respectively.

      Parameters:
      type - Specifies the type of Engagement context. Valid values are "CustomerProject" or "Document", indicating whether the context relates to a customer project or a document respectively.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      EngagementContextDetails.Builder type(EngagementContextType type)

      Specifies the type of Engagement context. Valid values are "CustomerProject" or "Document", indicating whether the context relates to a customer project or a document respectively.

      Parameters:
      type - Specifies the type of Engagement context. Valid values are "CustomerProject" or "Document", indicating whether the context relates to a customer project or a document respectively.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • payload

      EngagementContextDetails.Builder payload(EngagementContextPayload payload)

      Contains the specific details of the Engagement context. The structure of this payload varies depending on the Type field.

      Parameters:
      payload - Contains the specific details of the Engagement context. The structure of this payload varies depending on the Type field.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • payload

      default EngagementContextDetails.Builder payload(Consumer<EngagementContextPayload.Builder> payload)

      Contains the specific details of the Engagement context. The structure of this payload varies depending on the Type field.

      This is a convenience method that creates an instance of the EngagementContextPayload.Builder avoiding the need to create one manually via EngagementContextPayload.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to payload(EngagementContextPayload).

      Parameters:
      payload - a consumer that will call methods on EngagementContextPayload.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: