Options
All
  • Public
  • Public/Protected
  • All
Menu

Class UserTask

In version 10.12.0: deleted In version 9.0.5: removed experimental In version 9.0.2: introduced

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string = "Workflows$UserTask"

Static versionInfo

versionInfo: StructureVersionInfo = ...

Accessors

allowedModuleRoles

allowedModuleRolesQualifiedNames

  • get allowedModuleRolesQualifiedNames(): string[]

annotation

  • In version 9.15.0: introduced

    Returns null | workflows.Annotation

  • In version 9.15.0: introduced

    Parameters

    Returns void

autoAssignSingleTargetUser

  • get autoAssignSingleTargetUser(): boolean
  • set autoAssignSingleTargetUser(newValue: boolean): void

  • In version 9.11.0: introduced

    Returns boolean

  • In version 9.11.0: introduced

    Parameters

    • newValue: boolean

    Returns void

caption

  • get caption(): string
  • set caption(newValue: string): void

  • Returns string

  • Parameters

    • newValue: string

    Returns void

container

  • get container(): TContainer

  • Returns TContainer

containerAsFlow

dueDate

  • get dueDate(): string
  • set dueDate(newValue: string): void

  • The value of this property is conceptually of type microflowExpressions.MicroflowExpression.

    Returns string

  • The value of this property is conceptually of type microflowExpressions.MicroflowExpression.

    Parameters

    • newValue: string

    Returns void

isLoaded

  • get isLoaded(): boolean

  • Checks whether all attributes are available ATM

    • if false, a load is required to access these properties.

    Returns boolean

model

  • get model(): TModel

  • Returns TModel

name

  • get name(): string
  • set name(newValue: string): void

  • In version 9.0.5: introduced

    Returns string

  • In version 9.0.5: introduced

    Parameters

    • newValue: string

    Returns void

onCreatedEvent

outcomes

page

  • get page(): null | IPage
  • set page(newValue: null | IPage): void

  • In version 9.11.0: deleted

    Returns null | IPage

  • In version 9.11.0: deleted

    Parameters

    Returns void

pageQualifiedName

  • get pageQualifiedName(): null | string

persistentId

  • get persistentId(): string
  • set persistentId(newValue: string): void

  • In version 10.21.0: introduced

    Returns string

  • In version 10.21.0: introduced

    Parameters

    • newValue: string

    Returns void

qualifiedName

  • get qualifiedName(): null | string

  • Returns the qualified name of this element, or null if this element is not a part of the model, or if it or one of its namespace containers does not have a valid name.

    Returns null | string

taskDescription

taskName

taskPage

  • In version 9.12.0: added public In version 9.11.0: introduced

    Returns PageReference

  • This property is required and cannot be set to null.

    In version 9.12.0: added public In version 9.11.0: introduced

    Parameters

    Returns void

unit

userSource

userTaskCompletion

userTaskEntity

  • get userTaskEntity(): null | IEntity
  • set userTaskEntity(newValue: null | IEntity): void

userTaskEntityQualifiedName

  • get userTaskEntityQualifiedName(): null | string

Methods

allProperties

asLoaded

  • Transforms a IElement interface into a Element class, loading the containing unit if necessary. (Those are technically already the same, but this function makes sure its properties are available.)

    • If invoked without callback, it checks whether the properties are available or it will throw;
    • If invoked with callback, it will load the data from the server if needed, and then invoke the callback.

    Returns UserTask

deepCopy

deepCopyWithIdMap

delete

  • delete(): void

detach

findElementById

Protected getContainerAs

  • getContainerAs<T>(containerType: any): T

load

  • load(callback: (elem: UserTask) => void, forceRefresh?: boolean): void
  • load(forceRefresh?: boolean): Promise<UserTask>

  • Transforms a IElement interface into a Element class, loading the containing unit if necessary. (Those are technically already the same, but this function makes sure its properties are available.)

    • If invoked without callback, it checks whether the properties are available or it will throw;
    • If invoked with callback, it will load the data from the server if needed, and then invoke the callback.

    Parameters

    • callback: (elem: UserTask) => void
    • Optional forceRefresh: boolean

    Returns void

  • Parameters

    • Optional forceRefresh: boolean

    Returns Promise<UserTask>

loadedProperties

publicProperties

toJSON

  • toJSON(): IStructureJSON

  • Renders the structure as plain JSON (without observables magic). This is intended for debugging and development convenience. Note that the resulting object is not of the interface type corresponding to this structure.

    Returns IStructureJSON

traverse

  • traverse(visit: (structure: IStructure) => void): void

  • Traverses this structure by calling the provided visitor function on itself and all the structures contained (as part) by it, in depth-first order, and it returns synchronously after that.

    Parameters

    Returns void

traverseFind

  • traverseFind<T>(visit: (structure: IStructure) => T): null | T

traversePublicParts

  • traversePublicParts(visit: (structure: IStructure) => void): void

Static create

  • Creates and returns a new UserTask instance in the SDK and on the server. Expects one argument: the IModel object the instance will "live on". After creation, assign or add this instance to a property that accepts this kind of objects.

    Parameters

    • model: IModel

    Returns UserTask

Static createIn

  • Creates and returns a new UserTask instance in the SDK and on the server. The new UserTask will be automatically stored in the 'activities' property of the parent Flow element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 9.0.2 to 10.11.0

    Parameters

    Returns UserTask

Generated using TypeDoc