Class Group

A Group is a collection of individuals, often used in defining participants. It also has unique features in the Workspace interface, including an inbox for process instances.

Hierarchy (View Summary)

Constructors

constructor

Properties

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

Accessors

Email Name Oid RequireTakeResponsability

Methods

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

Constructors

constructor

  • new Group(context: Context): Group

  • Create a new instance of the type Group. 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 Group

Properties

ProtectedclassOid

classOid: string = ""

Protectedcontext

context: Context

Protectedemail

email: string = ""

Protectedfields

fields: IDictionary

ProtectedfieldsWithAlias

fieldsWithAlias: IDictionary

ProtectedisNew

isNew: boolean = false

Protectedlists

lists: IDictionary

Protectedname

name: string = ""

Protectedoid

oid: number = 0

ProtectedrequireTakeResponsability

requireTakeResponsability: boolean

StaticClassName

ClassName: string = "Venki.Organization.Group"

StaticClassOid

ClassOid: string = "a5f4d23c-811f-45df-9a1b-2d2d62d5df99"

Accessors

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

RequireTakeResponsability

  • get RequireTakeResponsability(): boolean

  • Returns boolean

  • set RequireTakeResponsability(value: boolean): void

  • Parameters

    • value: boolean

    Returns void

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 group.

    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 account (person or group) 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>

    Promise to get the object instance of a person or group.

StaticFindGroupAsync

  • FindGroupAsync(context: Context, id: number): Promise<Group>

  • Find a group 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<Group>

    Promise to get the object instance of a group.

StaticNewAsync

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

  • Create a new instance of an Group 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<Group>

    Promise to get the new object instance of a group.

StaticParse

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

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

    Object instance initialized.

StaticWhereAsync

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

  • 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<Group[]>

    Promise to get the 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