workflow-runtime/com.squareup.workflow1/WorkflowInterceptor/WorkflowSession

WorkflowSession

interface WorkflowSession(source)

Information about the session of a workflow in the runtime that a WorkflowInterceptor method is intercepting.

Properties

abstract val identifier: WorkflowIdentifier

The WorkflowIdentifier that represents the type of this workflow.

open val isRootWorkflow: Boolean

true if this is the root workflow, in which case parent is null.

abstract val parent: WorkflowInterceptor.WorkflowSession?

The parent WorkflowSession of this workflow, or null if this is the root workflow.

abstract val renderKey: String

The string key argument that was passed to BaseRenderContext.renderChild to render this workflow.

abstract val runtimeConfig: RuntimeConfig

The RuntimeConfig of the runtime this session is executing in.

abstract val sessionId: Long

A unique value that identifies the currently-running session of this workflow in the runtime. See the documentation on WorkflowInterceptor for more information about what this value represents.

abstract val workflowTracer: WorkflowTracer?

The optional WorkflowTracer of the runtime this session is executing in.