Class Person

A Person is an individual involved in executing or publishing a business process. Examples include the user responsible for a request, the requester, the process owner, and others.

Hierarchy (View Summary)

Constructors

constructor

Properties

classOid context departmentOid email fields fieldsWithAlias isNew lists name oid ClassName ClassOid

Accessors

DepartmentOid Email Name Oid

Methods

AddRecordAsync DeleteRecordAsync DeleteRecordsAsync Get GetKey GetListAsync GetStorageEndPoint LogChange Parse SaveAsync SaveRecordListAsync Set UpdateRecordAsync FindAsync NewAsync Parse WhereAsync

Constructors

constructor

  • new Person(context: Context): Person

  • Create a new instance of the type Person. In case of a new record use the method NewAsync instead of this constructor.

    Parameters

    • context: Context

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

    Returns Person

Properties

ProtectedclassOid

classOid: string = ""

Protectedcontext

context: Context

ProtecteddepartmentOid

departmentOid: number

Protectedemail

email: string = ""

Protectedfields

fields: IDictionary

ProtectedfieldsWithAlias

fieldsWithAlias: IDictionary

ProtectedisNew

isNew: boolean = false

Protectedlists

lists: IDictionary

Protectedname

name: string = ""

Protectedoid

oid: number = 0

StaticClassName

ClassName: string = "Venki.Organization.Person"

StaticClassOid

ClassOid: string = "8c6f3260-c030-40a7-8d60-60142fdef2a5"

Accessors

DepartmentOid

  • get DepartmentOid(): number

  • Get the identifier of the account department

    Returns number

  • set DepartmentOid(value: number): void

  • Set the identifier of the account department

    Parameters

    • value: number

    Returns void

Email

  • get Email(): string

  • Get the email of the account (person or group)

    Returns string

  • set Email(value: string): void

  • Set the email of the account (person or group)

    Parameters

    • value: string

    Returns void

Name

  • get Name(): string

  • Get the name of the account (person or group)

    Returns string

  • set Name(value: string): void

  • Set the identifier of the account (person or group)

    Parameters

    • value: string

    Returns void

Oid

  • get Oid(): number

  • Get the identifier of the account (person or group)

    Returns number

Methods

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.

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

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.

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

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<number>

  • Save all pending changes of the person.

    Parameters

    • context: Context

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

    Returns Promise<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<Person>

  • Find a person 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<Person>

    Object instance of a person.

StaticNewAsync

  • NewAsync(context: Context): Promise<Person>

  • Create a new instance of a person and initialize all fields.

    Parameters

    • context: Context

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

    Returns Promise<Person>

    Object instance of a person

StaticParse

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

  • 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 Person

    Object instance initialized.

StaticWhereAsync

  • WhereAsync(
        context: Context,
        filter: string,
        useCache?: boolean,
    ): Promise<Person[]>

  • Search for objects using filter criteria. To create the filter, use a condition that follows the OData filter syntax and includes the available fields fields in the environment.

    Parameters

    • context: Context

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

    • filter: string

      A filter expression following the OData filter syntax.

    • useCache: boolean = true

      It stores the content in a local cache for later reuse. The cache lifespan is approximately 600 seconds.

    Returns Promise<Person[]>

    A list of objects retrieved from the backend based on the search criteria. Note: the retrieval is limited to a maximum of 1,000 records.

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods