Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ActivityContext

Hierarchy

  • ActivityContext

Index

Constructors

Events

Methods

Constructors

constructor

  • Initializes a new instance of the {@link geocortex.workflow.ActivityContext} class.

    class

    Represents the runtime state of a workflow.

    constructs

    Parameters

    • dispatcher: ActivityDispatcher

      The activity dispatcher.

    • pendingIndex: number

      The index of the pending {@link geocortex.workflow.ExternalActivityInfo}.

    • workflow: Workflow

      The {@link geocortex.essentials.Workflow}.

    • workflowState: WorkflowState

      The internal workflow state object.

    Returns ActivityContext

Events

activityComplete

activityComplete: any

Occurs when an activity is completed.

Methods

Private _getRuntimeType

  • _getRuntimeType(value: any): string

  • Return the runtimeType of the value. Note that this is the .NET type name, for deserialization on the server.

    Parameters

    • value: any

    Returns string

abortActivity

  • abortActivity(): void

  • Aborts the activity in context.

    Returns void

completeActivity

  • completeActivity(): void

  • Completes the activity in context. Raises the activityComplete event.

    Returns void

dispatcher

getActivityExternalId

  • getActivityExternalId(): string

  • Gets the external id of the activity in context.

    Returns string

getActivityTypeName

  • getActivityTypeName(): string

  • Gets the type name of the activity in context.

    Returns string

getDisplayName

  • getDisplayName(): string

  • Gets the display name of the activity.

    Returns string

getEsriMap

  • getEsriMap(): Map

  • Gets the ESRI map associated with the running workflow.

    Returns Map

getInputArgumentRuntimeTypeName

  • getInputArgumentRuntimeTypeName(name: string): string

  • Gets the runtime type name of an input argument.

    Parameters

    • name: string

      The name of the input argument.

    Returns string

getInputArgumentTypeName

  • getInputArgumentTypeName(name: string): string

  • Gets the type name of an input argument.

    Parameters

    • name: string

      The name of the input argument.

    Returns string

getInputNames

  • getInputNames(): string[]

  • Gets a array of all input names in the activity.

    Returns string[]

getInputNamesByType

  • getInputNamesByType(typeName: string): string[]

  • Gets a array of all input names in the activity that match the specified type.

    Parameters

    • typeName: string

      The type name.

    Returns string[]

getJsonValue

  • getJsonValue(name: string): string

  • Gets the json value of an input argument.

    Parameters

    • name: string

      The name of the input.

    Returns string

getOutputJsonValue

  • getOutputJsonValue(name: string): string

  • Gets the json value of an output argument.

    Parameters

    • name: string

      The name of the output.

    Returns string

getOutputNames

  • getOutputNames(): string[]

  • Gets a array of all output names in the activity.

    Returns string[]

getOutputNamesByType

  • getOutputNamesByType(typeName: any): string[]

  • Gets a array of all output names in the activity that match the specified type.

    Parameters

    • typeName: any

    Returns string[]

getOutputValue

  • getOutputValue(name: string): any

  • Gets the value of an output argument.

    Parameters

    • name: string

      The name of the output.

    Returns any

getSite

  • Gets the Geocortex Essentials {@link geocortex.essentials.Site} associated with the running workflow.

    Returns Site

getValue

  • getValue(name: string): any

  • Gets the value of an input argument.

    Parameters

    • name: string

      The name of the input.

    Returns any

setValue

  • setValue(name: any, value: any, allowInsert?: boolean): void

  • Sets the value of an output argument.

    Parameters

    • name: any

      The name of the output.

    • value: any

      The value of the output.

    • Optional allowInsert: boolean

      Indicate that new output arguments can be added.

    Returns void

workflow

  • Gets the {@link geocortex.essentials.Workflow}.

    Returns Workflow