Class OnInitRecordList

Initialize the content of a new row in a record lists.

Hierarchy

  • PersonRecordContext
    • OnInitRecordList

Constructors

constructor

Accessors

AuthorizationHeader Cache CacheNoSQL CacheRelational CacheTTL Domain IsTest Person Record Region StorageNoSQL StorageRelational

Methods

addChange addComment addRecordChange CreateRequest FindAllAsync FindAsync GetModifiedData PatchAllAsync PatchAsync PostAsync QueryAsync Refresh removeRecordChange SendMailAsync WhereAsync BuildContextAsync QueryAsync

Constructors

constructor

Accessors

AuthorizationHeader

  • get AuthorizationHeader(): string

  • Retrieve the Authorization header from the last authentication.

    Returns string

Cache

  • get Cache(): NodeCache

  • Returns NodeCache

CacheNoSQL

  • get CacheNoSQL(): string

  • Returns string

CacheRelational

  • get CacheRelational(): string

  • Returns string

CacheTTL

  • get CacheTTL(): number

  • Returns number

Domain

  • get Domain(): string

  • Returns string

IsTest

  • get IsTest(): boolean

  • Returns boolean

Person

Record

Region

  • get Region(): string

  • Returns string

StorageNoSQL

  • get StorageNoSQL(): string

  • Returns string

StorageRelational

  • get StorageRelational(): string

  • Returns string

Methods

addChange

  • addChange(
        className: string,
        propertyName: string,
        key: string | number,
        value: Object,
    ): void

  • Parameters

    • className: string
    • propertyName: string
    • key: string | number
    • value: Object

    Returns void

addComment

  • addComment(message: string, workItem: WorkItem, token?: Token): void

  • Parameters

    Returns void

addRecordChange

  • addRecordChange(
        className: string,
        propertyName: string,
        key: string | number,
        value: Object,
    ): void

  • Parameters

    • className: string
    • propertyName: string
    • key: string | number
    • value: Object

    Returns void

CreateRequest

  • CreateRequest(method: Method): AxiosRequestConfig

  • Parameters

    • method: Method

    Returns AxiosRequestConfig

FindAllAsync

  • FindAllAsync(
        endPoint: string,
        classOid: string,
        parseCallback: (data: any) => BaseModel,
    ): Promise<BaseModel[]>

  • Parameters

    • endPoint: string
    • classOid: string
    • parseCallback: (data: any) => BaseModel

    Returns Promise<BaseModel[]>

FindAsync

  • FindAsync(
        endPoint: string,
        classOid: string,
        parseCallback: (data: any) => BaseModel,
    ): Promise<BaseModel>

  • Parameters

    • endPoint: string
    • classOid: string
    • parseCallback: (data: any) => BaseModel

    Returns Promise<BaseModel>

GetModifiedData

  • GetModifiedData(options?: GetModifiedDataOptions): Delta

  • Parameters

    • options: GetModifiedDataOptions = null

    Returns Delta

PatchAllAsync

  • PatchAllAsync(endPoint: string, entities: string[]): Promise<void>

  • Parameters

    • endPoint: string
    • entities: string[]

    Returns Promise<void>

PatchAsync

  • PatchAsync(
        endPoint: string,
        className: string,
        key: string | number,
        entities: string[],
    ): Promise<void>

  • Parameters

    • endPoint: string
    • className: string
    • key: string | number
    • entities: string[]

    Returns Promise<void>

PostAsync

  • PostAsync(endPoint: string, payload: any, fields: IDictionary): Promise<any>

  • Parameters

    • endPoint: string
    • payload: any
    • fields: IDictionary

    Returns Promise<any>

QueryAsync

  • QueryAsync(
        sql: string,
        page: number,
        itemsPerPage: number,
        parameters: QueryParam[],
        avoidCache?: boolean,
    ): Promise<any[]>

  • Run a Select command to retrieve data from the Export Database of the environment.

    Parameters

    • sql: string

      SQL SELECT statement.

    • page: number

      Page index, which must be 1 or greater.

    • itemsPerPage: number

      Page size, which must be 100 or less.

    • parameters: QueryParam[]

      Parameters of the SQL statement. Example: [{ name: "@name", value: 'mary' }]

    • avoidCache: boolean = false

      If true, the result will not be stored in the internal cache.

    Returns Promise<any[]>

    A promise to retrieve the records from the SELECT statement.

Refresh

  • Refresh(): Promise<void>

  • Renew the access token based on the environment, API key, and secret key provided for the static method BuildContextAsync

    Returns Promise<void>

removeRecordChange

  • removeRecordChange(className: string, key: string | number): void

  • Parameters

    • className: string
    • key: string | number

    Returns void

SendMailAsync

  • SendMailAsync(
        recipients: string[],
        subject: string,
        body: string,
        attachments?: string[],
        tokenOid?: number,
        sender?: string,
    ): Promise<void>

  • Send one email message to several recipients.

    Parameters

    • recipients: string[]

      Recipients of the message.

    • subject: string

      Field subject of the email.

    • body: string

      HTML body of the message.

    • Optionalattachments: string[]

      A list of urls of the attachments.

    • OptionaltokenOid: number

      The associated Token reference. If provided, the email will be accessible from the Conversation tab.

    • Optionalsender: string

      The sender name of the email.

    Returns Promise<void>

WhereAsync

  • WhereAsync(
        classOid: string,
        endPoint: string,
        filter: string,
        parseCallback: (data: any) => BaseModel,
        useCache?: boolean,
    ): Promise<BaseModel[]>

  • Parameters

    • classOid: string
    • endPoint: string
    • filter: string
    • parseCallback: (data: any) => BaseModel
    • useCache: boolean = true

    Returns Promise<BaseModel[]>

StaticBuildContextAsync

  • BuildContextAsync(
        environment: string,
        apiKey: string,
        secretKey: string,
    ): Promise<Context>

  • Generates an access token to access all functions of the API.

    Parameters

    • environment: string

      The environment identifier. It can be obtained from the Manage Environments page.

    • apiKey: string

      API key. It can be obtained from the Web Services panel inside the process editor.

    • secretKey: string

      Secret of the API key. It can be obtained from the Web Services panel inside the process editor.

    Returns Promise<Context>

StaticQueryAsync

  • QueryAsync(
        environment: string,
        apiKey: string,
        secretKey: string,
        sql: string,
        page: number,
        itemsPerPage: number,
        parameters: QueryParam[],
        avoidCache?: boolean,
    ): Promise<any[]>

  • Run a Select command to retrieve data from the Export Database of the environment.

    Parameters

    • environment: string

      The environment identifier. It can be obtained from the Manage Environments page.

    • apiKey: string

      An api key generated in the Web Services interface within the process editor.

    • secretKey: string

      A secret key generated in the Web Services interface within the process editor.

    • sql: string

      SQL SELECT statement.

    • page: number

      Page index, which must be 1 or greater.

    • itemsPerPage: number

      Page size, which must be 100 or less.

    • parameters: QueryParam[]

      Parameters of the SQL statement. Example: [{ name: "@name", value: 'mary' }]

    • avoidCache: boolean = false

      If true, the result will not be stored in the internal cache.

    Returns Promise<any[]>

    A promise to retrieve the records from the SELECT statement.

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods