Skip to main content

InitialOptions Constructors

An object defining constructors for the InitialOptions class.

InitialOptions(projectName, flowName, documentOptions, processId, requestId, eventId)​

Initializes a new instance of the InitialOptions class with specified project and flow names, document options, and optional process ID, request ID, and event ID.

Parameters:​

projectName (required): string
The name of the project.

flowName (required): string
The name of the flow.

documentOptions (required): List<StartParametersDocumentOption>
The list of document options.

processId (optional): long
The process identifier, defaulting to 0.

requestId (optional): long?
The request identifier, defaulting to null.

eventId (optional): int?
The event identifier, defaulting to null.

The constructor sets the following default values:

  • DocumentOptions to an empty list

InitialOptions(projectName, flowName, processId, requestId, eventId)​

Initializes a new instance of the InitialOptions class with specified project and flow names, and optional process ID, request ID, and event ID.

Parameters:​

projectName (required): string
The name of the project.

flowName (required): string
The name of the flow.

processId (optional): long
The process identifier, defaulting to 0.

requestId (optional): long?
The request identifier, defaulting to null.

eventId (optional): int?
The event identifier, defaulting to null.

The constructor sets the following default values:

  • DocumentParameters to an empty dictionary
  • DocumentOptions to an empty list

InitialOptions()​

Initializes a new instance of the InitialOptions class with default values.

The constructor sets the following default values:

  • ProcessId to 0
  • EventId to null
  • DocumentParameters to an empty dictionary
  • DocumentOptions to an empty list