Class Token

A Token is a concurrent component of a WorkItem. Typically, it is linked to the current task and associated with the user responsible for that task.

Hierarchy (View Summary)

Constructors

constructor

Properties

classOid context currentFlowElementOid? currentTokenExecution? endDate? fields fieldsWithAlias isNew lists number oid responsibleOid? sourceType? startDate? status? subject workItem? workItemOid? ClassOid

Accessors

CurrentTokenExecution EndDate Number Oid SourceType StartDate Status Subject WorkItem

Methods

AddComment AddRecordAsync CalcResourceAsync DeleteRecordAsync DeleteRecordsAsync Get GetCurrentFlowElementAsync GetKey GetListAsync GetResponsibleAsync GetStorageEndPoint LogChange LogErrorAsync LogInformationAsync LogWarningAsync Parse SaveAsync SaveRecordListAsync Set UpdateRecordAsync FindAsync GetTokensAsync Parse

Constructors

constructor

  • new Token(context: Context): Token

  • Create a new instance of the type Token. This constructor is used by the library's code and should not be used by API users.

    Parameters

    • context: Context

      Context information of the call. In most of the cases you can build the context using the request object.

    Returns Token

Properties

ProtectedclassOid

classOid: string = ""

Protectedcontext

context: Context

Protected OptionalcurrentFlowElementOid

currentFlowElementOid?: number

Protected OptionalcurrentTokenExecution

currentTokenExecution?: string

Protected OptionalendDate

endDate?: Date

Protectedfields

fields: IDictionary

ProtectedfieldsWithAlias

fieldsWithAlias: IDictionary

ProtectedisNew

isNew: boolean = false

Protectedlists

lists: IDictionary

Protectednumber

number: string = ""

Protectedoid

oid: number = 0

Protected OptionalresponsibleOid

responsibleOid?: number

Protected OptionalsourceType

sourceType?: string

Protected OptionalstartDate

startDate?: Date

Protected Optionalstatus

status?: TokenStatus

Protectedsubject

subject: string = ""

Protected OptionalworkItem

workItem?: WorkItem

Protected OptionalworkItemOid

workItemOid?: number

StaticClassOid

ClassOid: string = "78e3a4c9-8885-415d-bba1-1970e4d1cf97"

Accessors

CurrentTokenExecution

  • get CurrentTokenExecution(): string

  • Get the current task execution data of the token

    Returns string

EndDate

  • get EndDate(): Date

  • Get the end date and time of the token

    Returns Date

Number

Oid

SourceType

StartDate

  • get StartDate(): Date

  • Get the start date and time of the token

    Returns Date

Status

Subject

  • get Subject(): string

  • Get the subject of the token

    Returns string

  • set Subject(value: string): void

  • Set the identifier of the token

    Parameters

    • value: string

      The new content for the field Subject.

    Returns void

WorkItem

Methods

AddComment

  • AddComment(message: string): void

  • Add a comment in the Conversation tab.

    Parameters

    • message: string

      Content of the comment.

    Returns void

AddRecordAsync

  • AddRecordAsync(fieldName: string, record: any): Promise<CustomType>

  • Add a row to the record list.

    Parameters

    • fieldName: string

      Name of the record list.

    • record: any

      A dictionary containing all the fields of the row.

    Returns Promise<CustomType>

    A promise to retrieve the content of the new object added to the record list.

CalcResourceAsync

  • CalcResourceAsync(resourceName: string): Promise<Account[]>

  • Calculate the participant.

    Parameters

    • resourceName: string

      Name of the participant.

    Returns Promise<Account[]>

    Promise to get the array of groups of people related with the participant definition.

DeleteRecordAsync

  • DeleteRecordAsync(fieldName: string, instanceId: string): Promise<void>

  • Delete a row in a record list.

    Parameters

    • fieldName: string

      Name of the record list.

    • instanceId: string

      Identifier of the row of the record list.

    Returns Promise<void>

DeleteRecordsAsync

  • DeleteRecordsAsync(fieldName: string, instances: string[]): Promise<void>

  • Delete a list of rows in a record list.

    Parameters

    • fieldName: string

      Name of the record list.

    • instances: string[]

    Returns Promise<void>

Get

  • Get(fieldName: string): any

  • Get the value of a custom field.

    Parameters

    • fieldName: string

      Name or alias of the field. (click the script icon in the edition dialog)

    Returns any

    • Current value of the custom field.

GetCurrentFlowElementAsync

ProtectedGetKey

GetListAsync

  • GetListAsync(fieldName: string): Promise<CustomType[]>

  • Retrieve all rows from a record list field.

    Parameters

    • fieldName: string

      Name of the record list.

    Returns Promise<CustomType[]>

    A promise to retrieve the content record list.

GetResponsibleAsync

ProtectedGetStorageEndPoint

  • GetStorageEndPoint(id?: number): string

  • Parameters

    • Optionalid: number

    Returns string

ProtectedLogChange

  • LogChange(
        className: string,
        fieldName: string,
        key: string | number,
        value: any,
    ): void

  • Parameters

    • className: string
    • fieldName: string
    • key: string | number
    • value: any

    Returns void

LogErrorAsync

  • LogErrorAsync(message: string, detailLink?: string): Promise<void>

  • Log an Error message. Users can view the message content by accessing the edit dialog in the task list interface. Click the three-dot icon at the top right (or left in RTL) and select 'Logs'.

    Parameters

    • message: string

      Content of the message.

    • OptionaldetailLink: string

    Returns Promise<void>

LogInformationAsync

  • LogInformationAsync(message: string): Promise<void>

  • Log an Information message. Users can view the message content by accessing the edit dialog in the task list interface. Click the three-dot icon at the top right (or left in RTL) and select 'Logs'.

    Parameters

    • message: string

      Content of the message.

    Returns Promise<void>

LogWarningAsync

  • LogWarningAsync(message: string): Promise<void>

  • Log an Warning message. Users can view the message content by accessing the edit dialog in the task list interface. Click the three-dot icon at the top right (or left in RTL) and select 'Logs'.

    Parameters

    • message: string

      Content of the message.

    Returns Promise<void>

Parse

  • Parse(data: IDictionary): void

  • Populate the object's fields with data from the record.

    Parameters

    • data: IDictionary

      A dictionary holding the record's data.

    Returns void

SaveAsync

  • SaveAsync(context: Context): Promise<string | number>

  • Save all pending changes of the token.

    Parameters

    • context: Context

      Context information of the call. In most of the cases you can build the context using the request object.

    Returns Promise<string | number>

    Identifier of the saved record.

SaveRecordListAsync

  • SaveRecordListAsync(context: Context, fieldName: string): Promise<void>

  • Save all pending changes of a field of type record list.

    Parameters

    • context: Context

      Context information of the call. In most of the cases you can build the context using the request object.

    • fieldName: string

      Name of the record list.

    Returns Promise<void>

Set

  • Set(fieldName: string, value: any): void

  • Set the value of a custom field.

    Parameters

    • fieldName: string

      Name or alias of the field. (click the script icon in the edition dialog)

    • value: any

      Current value of the custom field.

    Returns void

UpdateRecordAsync

  • UpdateRecordAsync(
        fieldName: string,
        instanceId: string,
        record: any,
    ): Promise<void>

  • Update a row in a record list.

    Parameters

    • fieldName: string

      Name of the record list.

    • instanceId: string

      A list of identifiers for the rows in the record list.

    • record: any

      A dictionary containing all the fields of the row.

    Returns Promise<void>

StaticFindAsync

  • FindAsync(context: Context, id: number): Promise<Token>

  • Find a token by an identifier

    Parameters

    • context: Context

      Context information of the call. In most of the cases you can build the context using the request object.

    • id: number

      Identifier of the instance.

    Returns Promise<Token>

    Promise to get the object instance of a token.

StaticGetTokensAsync

  • GetTokensAsync(context: Context, workItemOid: number): Promise<Token[]>

  • Get a list of all tokens of the same WorkItem.

    Parameters

    • context: Context

      Context information of the call. In most of the cases you can build the context using the request object.

    • workItemOid: number

      Identifier of the WorkItem.

    Returns Promise<Token[]>

    Promise to get a list of tokens.

StaticParse

  • Parse(context: Context, data: any[]): Token

  • Load the object's content from JSON data.

    Parameters

    • context: Context

      Context information of the call. In most of the cases you can build the context using the request object.

    • data: any[]

      An array of key-value pairs (JSON data).

    Returns Token

    Object instance initialized.

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods