Class WorkflowDeploymentService

Manages workflow definitions and workflow activity authoring.

Hierarchy

Index

Constructor methods

Methods

Constructor methods

constructor(context: ClientRuntimeContext, objectPath: ObjectPathStaticProperty): WorkflowDeploymentService

Parameters

Returns

WorkflowDeploymentService

Methods

public customFromJson(initValue: any): boolean

Parameters

  • initValue: any

Returns

boolean

public deleteCollateral(workflowDefinitionId: string, leafFileName: string)

Deletes the URL of a workflow definition's collateral file.

Parameters

  • workflowDefinitionId: string

    The guid identifier of the workflow definition.

  • leafFileName: string

public deleteDefinition(definitionId: string)

Deletes a workflow definition.

Parameters

  • definitionId: string

    The guid identifier of the workflow definition.

public deprecateDefinition(definitionId: string)

Marks a workflow definition as deprecated. Currently running workflow instances are allowed to complete, but new instances of the workflow definition are prevented from starting.

Parameters

  • definitionId: string

public enumerateDefinitions(publishedOnly: boolean): WorkflowDefinitionCollection

Retrieves workflow definitions from the workflow store that match the tags.

Parameters

  • publishedOnly: boolean

Returns

WorkflowDefinitionCollection

public fromJson(initValue: any)

Parameters

  • initValue: any

public getActivitySignatures(lastChanged: string): ClientResult

Returns an XML representation of a collection of XAML class signatures for workflow definitions.

Parameters

  • lastChanged: string

Returns

ClientResult

public getCollateralUri(workflowDefinitionId: string, leafFileName: string): StringResult

Retrieves the URL of the collateral file of the workflow definition.

Parameters

  • workflowDefinitionId: string

    The guid identifier of the workflow definition.

  • leafFileName: string

    The leaf name of the collateral file.

Returns

StringResult

public getDefinition(definitionId: string): WorkflowDefinition

Retrieves a specified workflow definition from the workflow store.

Parameters

  • definitionId: string

    The guid identifier of the workflow definition.

Returns

WorkflowDefinition

public getDesignerActions(web: Web): StringResult

Returns an XML representation of a list of valid Workflow Manager Client 1.0 actions for the specified web (WorkflowInfo element).

Parameters

Returns

StringResult

public get_context(): ClientRuntimeContext

Returns

ClientRuntimeContext

public get_objectVersion(): string

Returns

string

public get_path(): ObjectPath

Returns

ObjectPath

public get_serverObjectIsNull(): boolean

Returns

boolean

public get_typedObject(): ClientObject

Returns

ClientObject

public isObjectPropertyInstantiated(propertyName: string): boolean

Parameters

  • propertyName: string

Returns

boolean

public isPropertyAvailable(propertyName: string): boolean

Parameters

  • propertyName: string

Returns

boolean

public packageDefinition(definitionId: any, packageDefaultFilename: any, packageTitle: any, packageDescription: any): StringResult

Packages a single workflow definition into a SharePoint solution package (.wsp file) and saves the package to the Site Assets library. Returns the URL of the package file in the Site Asset library. Remarks:

  1. This method does not activate the package.
  2. If a package with the same name already exists in the Site Assets library, the method adds an integer suffix in braces to the file name, e.g. packageDefaultFilename{2}.wsp

Parameters

  • definitionId: any

    The guid identifier of the workflow definition.

  • packageDefaultFilename: any

    The default filename to choose for the new package.

  • packageTitle: any

    The title of the package.

  • packageDescription: any

    The description of the package.

Returns

StringResult

public publishDefinition(definitionId: string)

Publishes a workflow definition to the workflow store.

Parameters

  • definitionId: string

public refreshLoad()

public retrieve()

public retrieve(propertyNames: Array<string>)

Parameters

  • propertyNames: Array<string>

public saveCollateral(workflowDefinitionId: string, leafFileName: string, fileContent: any)

Saves the collateral file of a workflow definition.

Parameters

  • workflowDefinitionId: string

    The guid identifier of the workflow definition.

  • leafFileName: string
  • fileContent: any

public saveDefinition(definition: WorkflowDefinition): GuidResult

Saves a SharePoint workflow definition to the workflow store.

Parameters

Returns

GuidResult

public set_objectVersion(value: string)

Parameters

  • value: string

public validateActivity(activityXaml: string): StringResult

Validates the specified activity against workflow definitions in the workflow store.

Parameters

  • activityXaml: string

Returns

StringResult