Class DefaultExtendedFulfillRequestedUploadRequest.Builder

java.lang.Object

de.xima.fc.common.form_record.chat.DefaultFulfillRequestedUploadRequest.BaseBuilder<IExtendedFulfillRequestedUploadRequest, DefaultExtendedFulfillRequestedUploadRequest.Builder>

de.xima.fc.logic.form_record.chat.DefaultExtendedFulfillRequestedUploadRequest.Builder

Enclosing class:

DefaultExtendedFulfillRequestedUploadRequest

public static final class DefaultExtendedFulfillRequestedUploadRequest.Builder
extends DefaultFulfillRequestedUploadRequest.BaseBuilder<IExtendedFulfillRequestedUploadRequest, DefaultExtendedFulfillRequestedUploadRequest.Builder>

Builder for a DefaultExtendedFulfillRequestedUploadRequest.

Since:

8.2.0

Method Summary

Modifier and Type	Method	Description
IExtendedFulfillRequestedUploadRequest	build()	Creates the data needed to fulfill a pending upload request.
DefaultExtendedFulfillRequestedUploadRequest.Builder	entityContext(IEntityContext entityContext)	Optional.
protected DefaultExtendedFulfillRequestedUploadRequest.Builder	self()
DefaultExtendedFulfillRequestedUploadRequest.Builder	workflowContext(IWorkflowExecutionContext workflowContext)	Optional.

Methods inherited from class DefaultFulfillRequestedUploadRequest.BaseBuilder

addFile, attachmentSource, buildBaseRequest, enforceChat, enforceExplicitContentType, enforceExplicitContentType, enforceMatchingUser, enforceMatchingUser, enforceMessage, files, files, initializeResponse, initializeResponse, locale, makeFilesAccessibleToEndUser, makeFilesAccessibleToEndUser, oathKeeper

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

build

public IExtendedFulfillRequestedUploadRequest build()

Description copied from class: DefaultFulfillRequestedUploadRequest.BaseBuilder

Creates the data needed to fulfill a pending upload request. Any modifications to the builder will not affect the built request.

Specified by:

build in class DefaultFulfillRequestedUploadRequest.BaseBuilder<IExtendedFulfillRequestedUploadRequest, DefaultExtendedFulfillRequestedUploadRequest.Builder>

Returns:

The data needed to fulfill a pending upload request.

entityContext

@CanIgnoreReturnValue
public DefaultExtendedFulfillRequestedUploadRequest.Builder entityContext(IEntityContext entityContext)

Optional. Sets the entity context to use for fulfilling the upload request.

Parameters:

entityContext - The entity context to use for fulfilling the upload request.

Returns:

This builder for chaining method calls.

workflowContext

@CanIgnoreReturnValue
public DefaultExtendedFulfillRequestedUploadRequest.Builder workflowContext(IWorkflowExecutionContext workflowContext)

Optional. Sets the workflow context where the upload request was fulfilled.

After the upload request is fulfilled, a request fulfillment event is triggered, which in turn may trigger a workflow execution. This will fail when a workflow execution is currently in progress. To avoid this, the workflow context should be given. When a workflow context is given, the matching tasks will be added to the current execution queue instead. This also prevents potential endless loops when a workflow task reacting to a request fulfillment event unfulfills the request and then fulfills it again, as there exists a hard limit on the maximum number of executed nodes per workflow execution.

Parameters:

workflowContext - The workflow execution context containing the action that issued the request fulfillment request.

Returns:

This builder for chaining method calls.

self

protected DefaultExtendedFulfillRequestedUploadRequest.Builder self()

Specified by:

self in class DefaultFulfillRequestedUploadRequest.BaseBuilder<IExtendedFulfillRequestedUploadRequest, DefaultExtendedFulfillRequestedUploadRequest.Builder>