Sys.Types
Sys.Types collects TypeScript types that app code uses to declare variables, parameters and return values, for example Sys.Types.Choice[] or Sys.Types.PagedData<This.Order>. Most entries exist only for the type check; the constants under Properties and the classes under Classes also exist at runtime.
Availability: Everywhere
The entries are grouped by topic:
| Topic | Entries |
|---|---|
| Choices and validation | Choice, HasChoices, ValidationError |
| Data queries and reports | FindManyOptions, FindManyPagedOptions, PagingDefinition, SortingDefinition, PagedData, allowedAggregationFunctions, AggregationInput, AggregationOutput, GroupedCount, ReportOptions, ReportResult, EntityState |
| Screens and forms | Form, ImageSelectorOutput, ClientLogLevel |
| Users and login | User, UserRole, UserPermission, UserRecord, LoginStages, LoginStage, UserIdentityTokenRecord |
| Processes | Swimlane, SwimlaneAssignment, ProcessScope, ProcessTokenScope, UserTaskToken, UserTaskTokenDetails |
MailType, MailBody, Mail | |
| Files and binary data | BinaryData, BinaryOrBase64, BinaryFile, BinaryDataOrFile, RedactionBox |
| Resources, integrations and AI | ResourceAvailabilityOnClientType, ServiceIntegrationAvailabilityOnClientType, ResourceDefinition, AiTypes, AiType |
| Google Maps | GoogleMapsGeoLocation, GoogleMapsRouteWaypoints, GoogleMapsRouteOptimizationTargets, GoogleMapsRouteOptimizationTarget, GoogleMapsRouteLegResult, GoogleMapsRouteSummary, GoogleMapsRouteResult, GoogleMapsClientConfig |
| Chat | ChatMessage, ChatMessageAttachment |
| Type helpers | RemoveMethods, NumberProperties, NumberPropertyKeys, StringProperties, StringPropertyKeys, TypedProperties, TypedPropertyKeys |
| Library types | See Re-exported library types. |
Properties
Section titled “Properties”allowedAggregationFunctions
Section titled “allowedAggregationFunctions”const allowedAggregationFunctions: readonly ["count", "sum", "min", "max", "avg"]The aggregation functions that a Server Data Store’s aggregate() method accepts in AggregationInput.aggregationFunction.
Type: readonly string[] · Availability: Everywhere
LoginStages
Section titled “LoginStages”const LoginStages: readonly ["credentials", "mfa", "passwordChangeNeeded", "successful"]The stages of a login, in order: entering credentials, multi-factor authentication, a required password change, and the completed login.
Type: readonly string[] · Availability: Everywhere
AiTypes
Section titled “AiTypes”const AiTypes: readonly ["AzureOpenAi", "Gemini", "Anthropic", "DeepSeek", "Ollama"]The AI providers that an AI Connection can use; see Sys.Ai.
Type: readonly string[] · Availability: Everywhere
GoogleMapsRouteOptimizationTargets
Section titled “GoogleMapsRouteOptimizationTargets”const GoogleMapsRouteOptimizationTargets: { readonly distance: "Shortest distance"; readonly time: "Fastest time";}The route optimization targets of Sys.GoogleMaps and the route picker component, with their display labels.
Type: object · Availability: Everywhere
Classes
Section titled “Classes”UserRecord
Section titled “UserRecord”class UserRecord { id: UserIdType; userName: string; firstName: string; lastName: string; email?: string; mobilePhone?: string; roleNames?: string[]; permissionNames?: string[]; groupNames?: string[]; manager?: UserRecord;}A reduced, shareable view of a user, with role, permission and group names instead of full objects. Sys.User returns users in this form.
| Field | Type | Required | Description |
|---|---|---|---|
id | UserIdType | Yes | ID of the user. |
userName | string | Yes | Login name. |
firstName | string | Yes | First name. |
lastName | string | Yes | Last name. |
email | string | No | Email address, if requested. |
mobilePhone | string | No | Mobile phone number, if requested. |
roleNames | string[] | No | Qualified names of the user’s roles, for example 'Purchasing.Approver'; system roles start with System.. |
permissionNames | string[] | No | Qualified names of the user’s permissions. |
groupNames | string[] | No | Names of the user’s groups. |
manager | UserRecord | No | The user’s manager, if requested. |
constructor()
Section titled “constructor()”constructor(init?: Partial<UserRecord> & Pick<UserRecord, 'roleNames' | 'permissionNames' | 'groupNames'>)Creates a user record from the given fields.
| Parameter | Type | Description |
|---|---|---|
init | Partial<UserRecord> | Optional. Field values; roleNames, permissionNames and groupNames must be given. |
getName()
Section titled “getName()”getName(): stringReturns the first and last name, separated by a space.
Returns: string · Availability: Everywhere
hasRole()
Section titled “hasRole()”hasRole(roleName: string): booleanChecks whether roleNames contains the given qualified role name.
| Parameter | Type | Description |
|---|---|---|
roleName | string | Qualified role name, for example 'Purchasing.Approver'. |
Returns: boolean · Availability: Everywhere
Note
hasRole() and hasSystemRole() throw if roleNames is not set; hasPermission() and hasSystemPermission() throw if permissionNames is not set.
hasSystemRole()
Section titled “hasSystemRole()”hasSystemRole(roleName: string): booleanChecks whether the user has the system role System.<roleName>.
| Parameter | Type | Description |
|---|---|---|
roleName | string | Name of the system role, without System.. |
Returns: boolean · Availability: Everywhere
hasPermission()
Section titled “hasPermission()”hasPermission(permissionName: string): booleanChecks whether permissionNames contains the given qualified permission name.
| Parameter | Type | Description |
|---|---|---|
permissionName | string | Qualified permission name. |
Returns: boolean · Availability: Everywhere
hasSystemPermission()
Section titled “hasSystemPermission()”hasSystemPermission(permissionName: string): booleanChecks whether the user has the system permission System.<permissionName>.
| Parameter | Type | Description |
|---|---|---|
permissionName | string | Name of the system permission, without System.. |
Returns: boolean · Availability: Everywhere
toUserIdAndName()
Section titled “toUserIdAndName()”toUserIdAndName(): anyReturns the user’s ID and full name as an object with userId and name.
Returns: any · Availability: Everywhere
UserTaskToken
Section titled “UserTaskToken”class UserTaskToken extends BaseTaskToken { assignedToUserId: string; assignedToName: string; processModuleId: ModuleIdType; processBoId: BusinessObjectIdType; screenModuleId: ModuleIdType; screenBoId: BusinessObjectIdType; swimlaneId: string; swimlaneName: string;}An open User Task of a Process instance, as listed for End users, for example by Sys.Process.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | ID of the task token. |
taskType | 'user' | 'script' | Yes | Kind of task. |
taskName | string | Yes | Name of the task. |
publicMetadata | Record<string, any> | No | Metadata copied from publicMetadata in the Process instance’s data. |
processInstanceId | number | Yes | ID of the Process instance. |
status | string | Yes | 'active' or 'error'. |
errorMessage | string | No | Error message if the status is 'error'. |
errorStack | string | No | Stack trace of the error. |
assignedToUserId | string | Yes | ID of the user the task is assigned to. |
assignedToName | string | Yes | Name of that user. |
processModuleId | ModuleIdType | Yes | Module of the Process. |
processBoId | BusinessObjectIdType | Yes | Name of the Process. |
screenModuleId | ModuleIdType | Yes | Module of the task’s Screen. |
screenBoId | BusinessObjectIdType | Yes | Name of the task’s Screen. |
swimlaneId | string | Yes | ID of the task’s swimlane. |
swimlaneName | string | Yes | Name of the task’s swimlane. |
constructor()
Section titled “constructor()”constructor(init?: OnlyData<UserTaskToken>)Creates a task token from the given field values.
| Parameter | Type | Description |
|---|---|---|
init | OnlyData<UserTaskToken> | Optional. Field values. |
getUrl()
Section titled “getUrl()”getUrl(): stringReturns the relative URL that opens the task, /<screenModuleId>/t/<id>.
Returns: string · Availability: Everywhere
UserTaskTokenDetails
Section titled “UserTaskTokenDetails”class UserTaskTokenDetails extends UserTaskToken { assignments: [string, any][]; outputs: string[]; outgoingFlows: ProcessOutgoingFlowInfo[]; layoutScreenModuleId: ModuleIdType; layoutScreenBoId: BusinessObjectIdType;}A UserTaskToken with the details needed to show and complete the task. It has all fields of UserTaskToken, plus:
| Field | Type | Required | Description |
|---|---|---|---|
assignments | [string, any][] | Yes | Input values of the task, as name and value pairs. |
outputs | string[] | Yes | Names of the task’s outputs. |
outgoingFlows | ProcessOutgoingFlowInfo[] | Yes | The flows by which the task can be completed. |
layoutScreenModuleId | ModuleIdType | Yes | Module of the layout Screen around the task’s Screen. |
layoutScreenBoId | BusinessObjectIdType | Yes | Name of the layout Screen. |
constructor()
Section titled “constructor()”constructor(init?: OnlyData<UserTaskTokenDetails>)Creates task details from the given field values.
| Parameter | Type | Description |
|---|---|---|
init | OnlyData<UserTaskTokenDetails> | Optional. Field values. |
Choice
Section titled “Choice”interface Choice<T = any> { id: T; label: string | number; $isOther?: boolean;}One option of a dropdown, radio group or similar selection, for example from a Static Entity’s getChoices().
| Field | Type | Required | Description |
|---|---|---|---|
id | T | Yes | Value stored when the option is selected. |
label | string | number | Yes | Text shown for the option. |
$isOther | boolean | No | Marks the option as an “other” option. |
Availability: Everywhere
HasChoices
Section titled “HasChoices”interface HasChoices { getChoices(...args: any[]): Choice[];}Anything that provides selection options through a getChoices() method, such as a Static Entity.
Availability: Everywhere
ValidationError
Section titled “ValidationError”type ValidationError = { error: string; skipSubsequentRules?: boolean; ruleId?: string;}The result of a failed validation rule.
| Field | Type | Required | Description |
|---|---|---|---|
error | string | Yes | Message shown to the End user. |
skipSubsequentRules | boolean | No | If true, the remaining validation rules are not checked. |
ruleId | string | No | ID of the rule that failed. |
Availability: Everywhere
FindManyOptions
Section titled “FindManyOptions”interface FindManyOptions<T extends EntityCommon> { select?: FindOptionsSelect<EntityRecord<T>>; where?: FindOptionsWhere<EntityRecord<T>>[] | FindOptionsWhere<EntityRecord<T>>; relations?: FindOptionsRelations<EntityRecord<T>>; order?: FindOptionsOrder<EntityRecord<T>>; cache?: boolean | number | { id: any; milliseconds: number }; lock?: { mode: 'optimistic'; version: number | Date } | { mode: 'pessimistic_read' | 'pessimistic_write' | 'dirty_read' | 'for_no_key_update' | 'for_key_share'; tables?: string[]; onLocked?: 'nowait' | 'skip_locked' }; transaction?: boolean; skip?: number; take?: number;}Options for loading Entities from a Server Data Store, a subset of TypeORM’s find options typed for the Entity T.
| Field | Type | Required | Description |
|---|---|---|---|
select | FindOptionsSelect | No | Properties to load. |
where | FindOptionsWhere | FindOptionsWhere[] | No | Condition the Entities must match; an array matches any of the conditions. |
relations | FindOptionsRelations | No | Related Entities to load along. |
order | FindOptionsOrder | No | Sort order, for example { createdAt: 'DESC' }. |
cache | boolean | number | { id: any; milliseconds: number } | No | Caches the query result; a number is the cache duration in milliseconds. |
lock | object | No | Locking mode: optimistic with a version, or a pessimistic mode with optional tables and onLocked. |
transaction | boolean | No | Runs the query in a transaction. |
skip | number | No | Number of Entities to skip, for paging. |
take | number | No | Maximum number of Entities to load. |
Availability: Everywhere
FindManyPagedOptions
Section titled “FindManyPagedOptions”type FindManyPagedOptions<T extends EntityCommon> = Omit<FindManyOptions<T>, 'take' | 'skip'>FindManyOptions without skip and take, for paged loading where a PagingDefinition sets the page.
Availability: Everywhere
PagingDefinition
Section titled “PagingDefinition”interface PagingDefinition { pageSize: number; pageIndex: number;}Which page of a list to load.
| Field | Type | Required | Description |
|---|---|---|---|
pageSize | number | Yes | Number of items per page. |
pageIndex | number | Yes | Zero-based index of the page. |
Availability: Everywhere
SortingDefinition
Section titled “SortingDefinition”interface SortingDefinition<K extends string> { by: K; direction?: 'asc' | 'desc';}Sorting by one property.
| Field | Type | Required | Description |
|---|---|---|---|
by | K | Yes | Name of the property to sort by. |
direction | 'asc' | 'desc' | No | Sort direction. |
Availability: Everywhere
PagedData
Section titled “PagedData”interface PagedData<T> extends PagingDefinition { list: T[]; length: number; pageStartIndex: number; pageEndIndex: number;}One page of a longer list, for example the result of a Server Data Store’s loadPageByCondition().
| Field | Type | Required | Description |
|---|---|---|---|
list | T[] | Yes | Items on this page. |
length | number | Yes | Total number of items across all pages. |
pageStartIndex | number | Yes | Zero-based index of the first item of this page within the whole list. |
pageEndIndex | number | Yes | Zero-based index of the last item of this page within the whole list. |
pageSize | number | Yes | Number of items per page. |
pageIndex | number | Yes | Zero-based index of this page. |
Availability: Everywhere
AggregationInput
Section titled “AggregationInput”interface AggregationInput<T extends EntityInstance, A extends (typeof allowedAggregationFunctions)[number], K extends keyof T, O extends string> { aggregationFunction: A; column: '*' | K; outputName: O;}One aggregation for a Server Data Store’s aggregate() method.
| Field | Type | Required | Description |
|---|---|---|---|
aggregationFunction | 'count' | 'sum' | 'min' | 'max' | 'avg' | Yes | Aggregation function. |
column | '*' | K | Yes | Property to aggregate, or '*' for all rows (with count). |
outputName | O | Yes | Name of the result property. |
Availability: Everywhere
AggregationOutput
Section titled “AggregationOutput”type AggregationOutput<T extends EntityInstance, A extends (typeof allowedAggregationFunctions)[number], G extends keyof T, K extends keyof T, O extends string> = { [P in G]: T[P];} & { [P in O]: A extends 'count' ? number : T[K];}One result row of aggregate(): the properties grouped by, plus the aggregated value under its outputName (a number for count, otherwise the property’s type).
Availability: Everywhere
GroupedCount
Section titled “GroupedCount”type GroupedCount<T extends EntityInstance, G extends keyof T> = { [P in G]: T[P];} & { $count: number;}One result row of a Server Data Store’s count() method with grouping: the properties grouped by, plus the number of Entities in $count.
Availability: Everywhere
ReportOptions
Section titled “ReportOptions”interface ReportOptions extends ReportView, PagingDefinition {}Options for running a Report: a report view (filters, sorts, aggregations, grouping and selected columns) plus the page to load.
| Field | Type | Required | Description |
|---|---|---|---|
description | string | No | Description of the view. |
filters | ReportViewFilter[] | Yes | Filters, each with property, operator and values. |
sorts | ReportViewSort[] | Yes | Sort order. |
aggregations | ReportViewAggregation[] | Yes | Aggregations to compute. |
groupBy | string[] | Yes | Properties to group by. |
select | string[] | No | Properties to include as columns. |
pageSize | number | Yes | Number of rows per page. |
pageIndex | number | Yes | Zero-based index of the page. |
Availability: Everywhere
ReportResult
Section titled “ReportResult”interface ReportResult<T = any> extends PagedData<T> { columns: { displayName: string; property: string }[];}One page of a Report’s result: the fields of PagedData, plus the columns.
| Field | Type | Required | Description |
|---|---|---|---|
columns | { displayName: string; property: string }[] | Yes | Columns of the result, with their display names. |
Availability: Everywhere
EntityState
Section titled “EntityState”class EntityState<T extends HasId> { get list(): T[]; get ids(): IdType<T>[]; get byId(): Record<IdType<T>, T>; set list(list: T[]); set byId(byId: Record<IdType<T>, T>); constructor(init?: Partial<EntityState<T>> | T[]);}A list of Entities that is also indexed by ID, used in client-side state. Setting list or byId updates the other views.
| Field | Type | Required | Description |
|---|---|---|---|
list | T[] | Yes | The Entities in order. |
ids | IdType<T>[] | Yes | Their IDs, read-only. |
byId | Record<IdType<T>, T> | Yes | The Entities by ID. |
Availability: Everywhere
interface Form { reset(): void; markAllAsTouched(): void; markAsTouched(): void; markAsPristine(): void; markAllAsDirty(): void; markAsDirty(): void; markAsUntouched(): void; get valid(): boolean; get invalid(): boolean; get pending(): boolean; get disabled(): boolean; get enabled(): boolean; get errors(): ValidationErrors | null; get pristine(): boolean; get dirty(): boolean; get touched(): boolean; get untouched(): boolean;}A form on a Screen, with the state and methods of an Angular form: whether its inputs are valid, changed (dirty) or visited (touched), and methods to reset it or change those states.
Availability: Everywhere
ImageSelectorOutput
Section titled “ImageSelectorOutput”interface ImageSelectorOutput { readonly dataUrl: string; readonly base64: string; readonly mimeType: string; readonly arrayBuffer: ArrayBuffer; readonly fileName: string; readonly fileNameExtension: string;}The image an End user selected in an image selector, in several representations.
| Field | Type | Required | Description |
|---|---|---|---|
dataUrl | string | Yes | The image as a data: URL. |
base64 | string | Yes | The image data, Base64-encoded. |
mimeType | string | Yes | MIME type, for example 'image/png'. |
arrayBuffer | ArrayBuffer | Yes | The image data. |
fileName | string | Yes | File name. |
fileNameExtension | string | Yes | File name extension. |
Availability: Everywhere
ClientLogLevel
Section titled “ClientLogLevel”type ClientLogLevel = 'success' | 'error' | 'warning' | 'info'Severity of a message shown to the End user in the browser.
Availability: Everywhere
class User { id: UserIdType; userName: string; firstName: string; lastName: string; email: string; mobilePhone: string; creationTimestamp: Date; updateTimestamp: Date; lastLogin?: Date; roles?: UserRole[]; idpRoles?: UserIdpRole[]; permissions?: UserPermission[]; configurations?: UserConfiguration[]; groups?: string[]; status: UserStatus; failedLoginAttempts: number; effectiveRoles?: UserRole[]; effectivePermissions?: UserPermission[]; identityProviderId?: string; identityProviderUserId?: string; managerUserId?: string; // … and methods}A user account with its roles and permissions, for example the initiator of a Process instance. Besides the fields below it has methods such as getName(), hasEffectiveRole(), hasPermission(), hasSystemRole(), isInGroup(), isActive() and mapToUserRecord().
| Field | Type | Required | Description |
|---|---|---|---|
id | UserIdType | Yes | ID of the user. |
userName | string | Yes | Login name. |
firstName | string | Yes | First name. |
lastName | string | Yes | Last name. |
email | string | Yes | Email address. |
mobilePhone | string | Yes | Mobile phone number. |
creationTimestamp | Date | Yes | When the user was created. |
updateTimestamp | Date | Yes | When the user was last changed. |
lastLogin | Date | No | Time of the last login. |
roles | UserRole[] | No | Roles assigned directly. |
idpRoles | UserIdpRole[] | No | Roles assigned by an identity provider. |
permissions | UserPermission[] | No | Permissions assigned directly. |
configurations | UserConfiguration[] | No | Per-user configuration values. |
groups | string[] | No | Names of the user’s groups. |
status | 'active' | 'passwordChangeNeeded' | 'blocked' | 'inactive' | 'deleted' | Yes | Account status. |
failedLoginAttempts | number | Yes | Number of failed logins since the last successful one. |
effectiveRoles | UserRole[] | No | All roles, including inherited ones. |
effectivePermissions | UserPermission[] | No | All permissions, including those granted through roles. |
identityProviderId | string | No | ID of the identity provider the user logs in with. |
identityProviderUserId | string | No | The user’s ID at that identity provider. |
managerUserId | string | No | ID of the user’s manager. |
Availability: Everywhere
UserRole
Section titled “UserRole”class UserRole { id?: number; userId?: UserIdType; roleModuleId: ModuleIdType; roleBoId: BusinessObjectIdType; tenantIds: string[]; appliesAlsoToSubTenants: boolean;}The assignment of a role to a user, optionally restricted to tenants. getQualifiedName() returns the role’s qualified name, <roleModuleId>.<roleBoId>.
| Field | Type | Required | Description |
|---|---|---|---|
id | number | No | ID of the assignment. |
userId | UserIdType | No | ID of the user. |
roleModuleId | ModuleIdType | Yes | Module of the role. |
roleBoId | BusinessObjectIdType | Yes | Name of the role. |
tenantIds | string[] | Yes | Tenants the assignment applies to. |
appliesAlsoToSubTenants | boolean | Yes | Whether it also applies to sub-tenants. |
Availability: Everywhere
UserPermission
Section titled “UserPermission”class UserPermission { id?: number; userId?: UserIdType; permissionModuleId: ModuleIdType; permissionBoId: BusinessObjectIdType; tenantIds: string[]; appliesAlsoToSubTenants: boolean;}The assignment of a permission to a user, optionally restricted to tenants. getQualifiedName() returns the permission’s qualified name, <permissionModuleId>.<permissionBoId>.
| Field | Type | Required | Description |
|---|---|---|---|
id | number | No | ID of the assignment. |
userId | UserIdType | No | ID of the user. |
permissionModuleId | ModuleIdType | Yes | Module of the permission. |
permissionBoId | BusinessObjectIdType | Yes | Name of the permission. |
tenantIds | string[] | Yes | Tenants the assignment applies to. |
appliesAlsoToSubTenants | boolean | Yes | Whether it also applies to sub-tenants. |
Availability: Everywhere
LoginStage
Section titled “LoginStage”type LoginStage = (typeof LoginStages)[number]One of the login stages in LoginStages: 'credentials', 'mfa', 'passwordChangeNeeded' or 'successful'.
Availability: Everywhere
UserIdentityTokenRecord
Section titled “UserIdentityTokenRecord”interface UserIdentityTokenRecord { identityProviderId?: string; accessToken: string; scopes: string[];}An access token that an identity provider issued for a user, for example to call Microsoft Graph on the user’s behalf with Sys.Microsoft.
| Field | Type | Required | Description |
|---|---|---|---|
identityProviderId | string | No | ID of the identity provider. |
accessToken | string | Yes | The access token. |
scopes | string[] | Yes | Scopes granted to the token. |
Availability: Everywhere
Swimlane
Section titled “Swimlane”interface Swimlane { id: string; name: string; assignee: User;}A swimlane of a Process instance and the user it is assigned to.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | ID of the swimlane. |
name | string | Yes | Name of the swimlane. |
assignee | User | Yes | User the swimlane is assigned to. |
Availability: Everywhere
SwimlaneAssignment
Section titled “SwimlaneAssignment”interface SwimlaneAssignment { users?: (User | UserIdType | string) | (User | UserIdType | string)[]; groups?: string | string[]; roles?: string | string[];}Who a swimlane is assigned to: users, groups or roles, each as a single value or a list.
| Field | Type | Required | Description |
|---|---|---|---|
users | User | UserIdType | string, or a list of them | No | Users, as objects, IDs or user names. |
groups | string | string[] | No | Group names. |
roles | string | string[] | No | Qualified role names. |
Availability: Everywhere
ProcessScope
Section titled “ProcessScope”interface ProcessScope<P = Record<string, any>> { process: P; initiator: User | null; startSignalName?: string; startMessageName?: string; startTimerActivityId?: string; startMessageData?: any; action?: string;}The data of a Process instance that its scripts can access.
| Field | Type | Required | Description |
|---|---|---|---|
process | P | Yes | The Process instance’s data. |
initiator | User | null | Yes | The user who started the Process instance, or null. |
startSignalName | string | No | Name of the signal that started the instance. |
startMessageName | string | No | Name of the message that started the instance. |
startTimerActivityId | string | No | ID of the timer start event that started the instance. |
startMessageData | any | No | Data of the start message. |
action | string | No | Name of the action with which an End user last completed a User Task’s Screen. |
Availability: Everywhere
ProcessTokenScope
Section titled “ProcessTokenScope”interface ProcessTokenScope<P = Record<string, any>, T = Record<string, any>> extends ProcessScope<P> { token: T; action: string; swimlane: Swimlane;}The scope parameter of Process scripts that run for a token: the fields of ProcessScope, plus the token’s data.
| Field | Type | Required | Description |
|---|---|---|---|
token | T | Yes | The token’s variables. |
action | string | Yes | Name of the action with which an End user last completed a User Task’s Screen. |
swimlane | Swimlane | Yes | The swimlane the token is in. |
Availability: Everywhere
MailType
Section titled “MailType”type MailType = 'mail' | 'readReceipt' | 'nonDeliveryReport'Kind of a received email: a normal mail, a read receipt, or a report that a mail could not be delivered.
Availability: Everywhere
MailBody
Section titled “MailBody”interface MailBody extends ParsedMail { sequenceNumber: number; statusCode: string | undefined; mailType: MailType;}A received email as parsed by mailparser (subject, sender, recipients, text, HTML, attachments, headers, …), plus Lowgile’s fields.
| Field | Type | Required | Description |
|---|---|---|---|
sequenceNumber | number | Yes | IMAP sequence number of the mail in the mailbox. |
statusCode | string | undefined | Yes | Delivery status code from a delivery status notification, for example '5.1.1'. |
mailType | MailType | Yes | Kind of mail. |
For the fields of ParsedMail, see the mailparser documentation (package mailparser, version ^3.9.3).
Availability: Everywhere
type Mail = MailBody & Imap.ImapMessageAttributes & { getFragments(): { getContent(): string; isSignature(): boolean; isQuoted(): boolean; isHidden(): boolean; isEmpty(): boolean; }[]; getVisibleText(options?: { aggressive?: boolean }): string; getHtmlWithHeaders(): string;}A received email as the IMAP client of Sys.Mail returns it: a MailBody with the IMAP message attributes (uid, flags, date, size, …) and methods that split the text into fragments.
| Field | Type | Required | Description |
|---|---|---|---|
getFragments | () => Fragment[] | Yes | Splits the text into fragments, each of which tells whether it is a signature, quoted, hidden or empty. |
getVisibleText | (options?) => string | Yes | Returns the text without quoted replies and signatures. With aggressive: true, visible fragments between hidden ones are treated as hidden too. |
getHtmlWithHeaders | () => string | Yes | Returns the HTML body with the mail headers shown on top. |
Availability: Everywhere
BinaryData
Section titled “BinaryData”type BinaryData = ArrayBuffer | Buffer | File | Blob | Uint8ArrayBinary content in any of the usual JavaScript representations.
Availability: Everywhere
BinaryOrBase64
Section titled “BinaryOrBase64”type BinaryOrBase64 = BinaryData | stringBinary content, or the same as a Base64-encoded string.
Availability: Everywhere
BinaryFile
Section titled “BinaryFile”interface BinaryFile<T = BinaryData> { data: T; fileName?: string; mimeType?: string;}Binary content with its file name and MIME type.
| Field | Type | Required | Description |
|---|---|---|---|
data | T | Yes | The content. |
fileName | string | No | File name. |
mimeType | string | No | MIME type, for example 'application/pdf'. |
Availability: Everywhere
BinaryDataOrFile
Section titled “BinaryDataOrFile”type BinaryDataOrFile<T = BinaryData> = T | BinaryFile<T>Binary content, either alone or as a BinaryFile with file name and MIME type.
Availability: Everywhere
RedactionBox
Section titled “RedactionBox”interface RedactionBox { x1: number; y1: number; x2: number; y2: number;}A rectangle on a PDF page to black out, given by two opposite corners; see Sys.Pdf.
| Field | Type | Required | Description |
|---|---|---|---|
x1 | number | Yes | Horizontal position of the first corner. |
y1 | number | Yes | Vertical position of the first corner. |
x2 | number | Yes | Horizontal position of the opposite corner. |
y2 | number | Yes | Vertical position of the opposite corner. |
Availability: Everywhere
ResourceAvailabilityOnClientType
Section titled “ResourceAvailabilityOnClientType”type ResourceAvailabilityOnClientType = 'none' | 'downloadable' | 'builtin'How a Resource is available on the client: not at all, downloadable by URL, or built into the app.
Availability: Everywhere
ServiceIntegrationAvailabilityOnClientType
Section titled “ServiceIntegrationAvailabilityOnClientType”type ServiceIntegrationAvailabilityOnClientType = 'none' | 'builtin'Whether a Service Integration is available on the client.
Availability: Everywhere
ResourceDefinition
Section titled “ResourceDefinition”interface ResourceDefinition<EL extends ExecutionLocation, Avail extends Omit<ResourceAvailabilityOnClientType, 'none'>> { resourceType: ResourceType; mimeType: string; fileName: string; relativeUrl: string; absoluteUrl: string; getDataBase64?: EL extends 'server' ? () => Promise<string> : Avail extends 'builtin' ? () => Promise<string> : never; getDataBuffer?: EL extends 'server' ? () => Promise<Buffer> : never; getDataString?: EL extends 'server' ? () => Promise<string> : Avail extends 'builtin' ? () => Promise<string> : never;}The type of a Resource Business Object in app code; see Resource. Which data methods exist depends on where the code runs and on the Resource’s client availability.
| Field | Type | Required | Description |
|---|---|---|---|
resourceType | ResourceType | Yes | Kind of Resource. |
mimeType | string | Yes | MIME type of the file. |
fileName | string | Yes | File name. |
relativeUrl | string | Yes | URL of the file, relative to the app. |
absoluteUrl | string | Yes | Absolute URL of the file, based on the app’s public URL. |
getDataBase64 | () => Promise<string> | No | Returns the content Base64-encoded. On the server, or on the client for built-in Resources. |
getDataBuffer | () => Promise<Buffer> | No | Returns the content as a Buffer. On the server only. |
getDataString | () => Promise<string> | No | Returns the content as text. On the server, or on the client for built-in Resources. |
Availability: Everywhere
AiType
Section titled “AiType”type AiType = (typeof AiTypes)[number]One of the AI providers in AiTypes.
Availability: Everywhere
GoogleMapsGeoLocation
Section titled “GoogleMapsGeoLocation”interface GoogleMapsGeoLocation { lat: number; lng: number; placeId?: string; name?: string; formattedAddress?: string;}A point on the map, with the place found there if known.
| Field | Type | Required | Description |
|---|---|---|---|
lat | number | Yes | Latitude in degrees. |
lng | number | Yes | Longitude in degrees. |
placeId | string | No | Google place ID. |
name | string | No | Name of the place. |
formattedAddress | string | No | Address as formatted by Google. |
Availability: Everywhere
GoogleMapsRouteWaypoints
Section titled “GoogleMapsRouteWaypoints”interface GoogleMapsRouteWaypoints { start?: GoogleMapsGeoLocation; vias: GoogleMapsGeoLocation[]; destination?: GoogleMapsGeoLocation;}The points a route passes, in order.
| Field | Type | Required | Description |
|---|---|---|---|
start | GoogleMapsGeoLocation | No | Start of the route. |
vias | GoogleMapsGeoLocation[] | Yes | Intermediate stops, in order. |
destination | GoogleMapsGeoLocation | No | End of the route. |
Availability: Everywhere
GoogleMapsRouteOptimizationTarget
Section titled “GoogleMapsRouteOptimizationTarget”type GoogleMapsRouteOptimizationTarget = keyof typeof GoogleMapsRouteOptimizationTargetsWhat a route is optimized for: 'distance' (shortest) or 'time' (fastest).
Availability: Everywhere
GoogleMapsRouteLegResult
Section titled “GoogleMapsRouteLegResult”interface GoogleMapsRouteLegResult { distanceMeters: number; durationSeconds: number;}Length and travel time of one leg of a route, from one waypoint to the next.
| Field | Type | Required | Description |
|---|---|---|---|
distanceMeters | number | Yes | Distance in meters. |
durationSeconds | number | Yes | Travel time in seconds. |
Availability: Everywhere
GoogleMapsRouteSummary
Section titled “GoogleMapsRouteSummary”interface GoogleMapsRouteSummary { distanceMeters: number; durationSeconds: number; legs: GoogleMapsRouteLegResult[]; encodedPolyline: string;}Totals, legs and path of one route.
| Field | Type | Required | Description |
|---|---|---|---|
distanceMeters | number | Yes | Total distance in meters. |
durationSeconds | number | Yes | Total travel time in seconds. |
legs | GoogleMapsRouteLegResult[] | Yes | One entry per leg. |
encodedPolyline | string | Yes | Path of the whole route in Google’s encoded polyline format. |
Availability: Everywhere
GoogleMapsRouteResult
Section titled “GoogleMapsRouteResult”interface GoogleMapsRouteResult { waypoints: GoogleMapsRouteWaypoints; chosenRoute: GoogleMapsRouteSummary; shortestDirectRoute: GoogleMapsRouteSummary; optimizeFor: GoogleMapsRouteOptimizationTarget; timeDependent: boolean; departureTime?: string; computedAt: string;}A planned route, as the route picker component and Sys.GoogleMaps.planRoute() produce it.
| Field | Type | Required | Description |
|---|---|---|---|
waypoints | GoogleMapsRouteWaypoints | Yes | The waypoints the route was planned for. |
chosenRoute | GoogleMapsRouteSummary | Yes | Route through all vias. |
shortestDirectRoute | GoogleMapsRouteSummary | Yes | Shortest route directly from start to destination, without vias, for example to detect detours. Always distance-optimized and without traffic, but with the same avoid options. |
optimizeFor | GoogleMapsRouteOptimizationTarget | Yes | What the chosen route was optimized for. |
timeDependent | boolean | Yes | Whether traffic at the departure time was considered. |
departureTime | string | No | Departure time as an ISO timestamp; only set for time-dependent routing. |
computedAt | string | Yes | When the route was computed, as an ISO timestamp. |
Availability: Everywhere
GoogleMapsClientConfig
Section titled “GoogleMapsClientConfig”interface GoogleMapsClientConfig { apiKey: string; mapId?: string | null;}The part of a Google Maps Configuration Item that the client uses to show maps.
| Field | Type | Required | Description |
|---|---|---|---|
apiKey | string | Yes | Browser API key. |
mapId | string | null | No | Map ID, required for advanced markers. |
Availability: Everywhere
ChatMessage
Section titled “ChatMessage”interface ChatMessage { id: number; userIdAndName: UserIdAndName; timestamp: Date; type: 'message' | 'action'; isHtml?: boolean; actionType?: string; actionName?: string; actionIcon?: string; message: string; attachments: ChatMessageAttachment[];}One message in a chat.
| Field | Type | Required | Description |
|---|---|---|---|
id | number | Yes | ID of the message. |
userIdAndName | UserIdAndName | Yes | Author, as userId and name. |
timestamp | Date | Yes | When the message was written. |
type | 'message' | 'action' | Yes | A text message, or a recorded action. |
isHtml | boolean | No | Whether message is HTML. |
actionType | string | No | Kind of action, for type: 'action'. |
actionName | string | No | Name of the action. |
actionIcon | string | No | Icon of the action. |
message | string | Yes | Text of the message. |
attachments | ChatMessageAttachment[] | Yes | Attached files. |
Availability: Everywhere
ChatMessageAttachment
Section titled “ChatMessageAttachment”interface ChatMessageAttachment { id: number; mimeType?: string; previewImage: ArrayBuffer | null; content: ArrayBuffer;}A file attached to a chat message.
| Field | Type | Required | Description |
|---|---|---|---|
id | number | Yes | ID of the attachment. |
mimeType | string | No | MIME type. |
previewImage | ArrayBuffer | null | Yes | Preview image, if any. |
content | ArrayBuffer | Yes | Content of the file. |
Availability: Everywhere
RemoveMethods
Section titled “RemoveMethods”type RemoveMethods<T extends object> = { [P in keyof T]: T[P] extends (...args: any[]) => any ? never : T[P];}T with the type of every method property changed to never, leaving only data properties usable.
Availability: Everywhere
NumberProperties
Section titled “NumberProperties”type NumberProperties<T> = { [K in keyof T]: T[K] extends number ? K : never;}Maps each property of T to its own name if it is a number, otherwise to never.
Availability: Everywhere
NumberPropertyKeys
Section titled “NumberPropertyKeys”type NumberPropertyKeys<T> = keyof NumberProperties<T>Intended as the names of the number properties of T; used by Sys.Math.
Availability: Everywhere
Note
As declared, NumberPropertyKeys<T> is the same as keyof T: it accepts every property name. The same applies to StringPropertyKeys and TypedPropertyKeys.
StringProperties
Section titled “StringProperties”type StringProperties<T> = { [K in keyof T]: T[K] extends string ? K : never;}Maps each property of T to its own name if it is a string, otherwise to never.
Availability: Everywhere
StringPropertyKeys
Section titled “StringPropertyKeys”type StringPropertyKeys<T> = keyof StringProperties<T>Intended as the names of the string properties of T; see the note under NumberPropertyKeys.
Availability: Everywhere
TypedProperties
Section titled “TypedProperties”type TypedProperties<T, U> = { [K in keyof T]: T[K] extends U ? K : never;}Maps each property of T to its own name if its type is assignable to U, otherwise to never.
Availability: Everywhere
TypedPropertyKeys
Section titled “TypedPropertyKeys”type TypedPropertyKeys<T, U> = keyof TypedProperties<T, U>Intended as the names of the properties of T whose type is assignable to U; see the note under NumberPropertyKeys.
Availability: Everywhere
Re-exported library types
Section titled “Re-exported library types”Sys.Types also re-exports these types from libraries unchanged:
| Type | Package | What it is |
|---|---|---|
FindOptionsSelect, FindOptionsWhere, FindOptionsRelations, FindOptionsOrder | typeorm (1.1.1) | Parts of TypeORM’s find options, used in FindManyOptions. See the TypeORM find options documentation. |
MailObject | nodemailer (^8.0.1) | Nodemailer’s SendMailOptions: the description of an email to send. See the Nodemailer message documentation. |
Request, Response | express (^4.22.1) | HTTP request and response objects of Express. See the Express API documentation. |
CdkDragDrop, CdkDragEnd, CdkDragEnter, CdkDragExit, CdkDragMove, CdkDragRelease, CdkDragStart | @angular/cdk (22.2.3) | Events of Angular CDK drag and drop. See the Angular CDK drag and drop documentation. |
MatChipInputEvent | @angular/material (22.2.3) | Event emitted when an End user enters a chip in a chip input. See the Angular Material chips documentation. |
ChartConfiguration | chart.js (^4.5.1) | Configuration of a Chart.js chart. See the Chart.js configuration documentation. |
Availability: Everywhere