Type parameters
Hierarchy
-
BaseApplicationItemRef<Data, Params, TProcesses>
- ApplicationProjectItemRef
Properties
Readonly code
App code of the URL’s target (the app’s code).
Readonly id
ID of the URL’s target.
Readonly namespace
Namespace of the URL target (the code of the workspace that the app belongs to).
Methods
createDraft
-
The method allows creating a new empty draft or a draft based on a project plan.
const plan = await project.getCurrentPlan(); const newDraft = await createDraft(plan);
Parameters
-
Optional payload: ProjectPlanStructure
Returns Promise<ProjectDraftStructure>
-
delete
-
The method allows you to delete an app item.
await Context.data.app.delete();
Returns Promise<void>
docflow
-
This method returns an object to work with document management operations.
const item = await Context.data.n1; const approvalLists = await item.docflow().getApprovalLists();
Returns DocflowApplicationItemRef
fetch
-
Request complete data of a reference object.
Returns Promise<BaseApplicationItem<Data, Params>>
getCurrentPlan
-
The method allows getting the current project plan.
const plan = await project.getCurrentPlan();
Returns Promise<ProjectPlanStructure | undefined>
getDraft
-
The method allows getting the project draft.
const draft = await project.getDraft();
Returns Promise<ProjectDraftStructure | undefined>
getFolder
-
The method returns the folder from the folder tree that an item is in.
const item = await Context.data.n1; const folder = await item. getFolder();
Returns Promise<TFolder | undefined>
getPlanByVersion
-
The method allows getting the project plan by its version.
const plan = await project.getPlanByVersion();
Parameters
-
version: number
Returns Promise<ProjectPlanStructure | undefined>
-
getRegistrations
Deprecated
-
Deprecated
Deprecated. Get a list of registrations of an app item.
const item = Context.data.d1! await item.getRegistrations();
Returns Promise<ApplicationItemRegistration[]>
getSettings
-
The method returns an app’s settings.
const app = Context.data.dokument; if (app === undefined) { return; } const settings = await app.getSettings();
Returns Promise<TSettings>
manualRegister
Deprecated
-
Deprecated
Deprecated. Manual registration of an app item (if manual registration is enabled in the folder’s settings).
Parameters
-
nameReg: string
-
nomenclatureId: string
Returns Promise<boolean>
-
register Deprecated
-
Deprecated
Deprecated. Automatic app item registration.
Parameters
-
nomenclatureId: string
Returns Promise<boolean>
-
restore
-
The method allows you to restore a deleted app item.
await Context.data.app.restore();
Returns Promise<void>
sendMessage
-
The method allows sending messages to an app item’s activity stream.
Parameters
-
title: string
-
message: string
Returns Promise<void>
-
setFolder
-
The allows you to change the app item’s folder in the Folder hierarchy.
Parameters
-
id: string
Returns Promise<void>
-
Reference object to a project plan element
Reference objects are usually used in App type properties in order to avoid loading all the associated data. To read the entire app item data, call method ApplicationProjectItemRef.fetch , and to get the entire item object, call ApplicationProjectItem.
const my_app_full = await Context.data.my_app.fetch();