ApplicationProjectItemRef

Объект-ссылка элемента плана проекта

Объекты-ссылки, как правило, используются в свойствах типа Приложение, чтобы не загружать сразу все связанные данные.

Чтобы считать полные данные элемента приложения, нужно вызвать метод ApplicationProjectItemRef.fetch и получить полный объект элемента ApplicationProjectItem.

const my_app_full = await Context.data.my_app.fetch();

Type parameters

Hierarchy

Properties

Readonly code

code: string

Код приложения цели ссылки (код приложения).

Readonly id

id: string

Идентификатор цели ссылки.

Readonly namespace

namespace: string

Пространство имён цели ссылки (код раздела приложения).

Methods

createDraft

  • createDraft(payload?: ProjectPlanStructure): Promise<ProjectDraftStructure>

  • Метод позволяет создать либо новый пустой черновик, либо черновик от плана проекта.

    const plan = await project.getCurrentPlan();
const newDraft = await createDraft(plan);

    Parameters

    • Optional payload: ProjectPlanStructure

    Returns Promise<ProjectDraftStructure>

delete

  • delete(): Promise<void>

  • Метод позволяет мягко удалить элемент приложения.

    await Context.data.app.delete();

    Returns Promise<void>

docflow

  • Метод получает объект для работы с документооборотом.

    const item = await Context.data.n1;
const approvalLists = await item.docflow().getApprovalLists();

    Returns DocflowApplicationItemRef

fetch

getCurrentPlan

  • getCurrentPlan(): Promise<ProjectPlanStructure | undefined>

  • Метод позволяет получить текущий план проекта.

    const plan = await project.getCurrentPlan();

    Returns Promise<ProjectPlanStructure | undefined>

getDraft

  • getDraft(): Promise<ProjectDraftStructure | undefined>

  • Метод позволяет получить черновик проекта.

    const draft = await project.getDraft();

    Returns Promise<ProjectDraftStructure | undefined>

getFolder

  • getFolder(): Promise<TFolder | undefined>

  • Метод позволяет получить папку элемента иерархического справочника.

    const item = await Context.data.n1;
const folder = await item.getFolder();

    Returns Promise<TFolder | undefined>

getPlanByVersion

  • getPlanByVersion(version: number): Promise<ProjectPlanStructure | undefined>

  • Метод позволяет получить план проекта по его версии.

    const plan = await project.getPlanByVersion();

    Parameters

    • version: number

    Returns Promise<ProjectPlanStructure | undefined>

getRegistrations Устарело

  • Метод устарел. Получение списка регистраций элемента приложения.

    const item = Context.data.d1!
await item.getRegistrations();
    Устарело

    Метод устарел. Используйте docflow:

    const item = Context.data.d1!
await item.docflow().getRegistrations();

    Returns Promise<ApplicationItemRegistration[]>

getSettings

  • Метод позволяет получить настройки приложения.

    const app = Context.data.dokument;
if (app === undefined) {
 return;
}
const settings = await app.getSettings();

    Returns Promise<TSettings>

hardDelete

  • hardDelete(): Promise<void>

  • Метод позволяет безвозвратно удалить элемент приложения.

    Операция доступна только для мягко удалённого элемента (с __deletedAt !== null). При попытке удалить активный элемент метод вернёт ошибку:

    fail to hard delete items: cannot hard delete item with id «019db3d5-6e26-7128-bde8-f0bd222018ba» reason: __deletedAt === null.

    Если функция безвозвратного удаления выключена в вашей компании, метод вернёт ошибку: method not available.

    const app = Context.data.applicationItem;
if (!app) {
 return;
}
const appFetch = await app.fetch();
if (appFetch.data.__deletedAt)  {
 await app.hardDelete();
}

    Returns Promise<void>

manualRegister Устарело

  • manualRegister(nameReg: string, nomenclatureId: string): Promise<boolean>

  • Метод устарел. Регистрация элемента приложения вручную (если включена регистрация вручную в настройках дела).

    Устарело

    Метод устарел. Используйте docflow:

    const item = Context.data.d1!
const settings = await Application.getSettings();
settings.registrationSettings.nomenclatureIds.forEach(nomenclatureId => {
     item.docflow().manualRegister("Номер 1", nomenclatureId);
})

    Parameters

    • nameReg: string
    • nomenclatureId: string

    Returns Promise<boolean>

register Устарело

  • register(nomenclatureId: string): Promise<boolean>

  • Метод устарел. Автоматическая регистрация элемента приложения.

    Устарело

    Метод устарел. Используйте docflow:

    const item = Context.data.d1!
const settings = await Application.getSettings();
settings.registrationSettings.nomenclatureIds.forEach(nomenclatureId => {
     item.docflow().register(nomenclatureId);
})

    Parameters

    • nomenclatureId: string

    Returns Promise<boolean>

restore

  • restore(): Promise<void>

  • Метод позволяет восстановить мягко удалённый элемент приложения.

    await Context.data.app.restore();

    Returns Promise<void>

sendMessage

  • sendMessage(title: string, message: string): Promise<void>

  • Метод позволяет отправлять сообщения в ленту элемента приложения.

    Parameters

    • title: string
    • message: string

    Returns Promise<void>

setFolder

  • setFolder(id: string): Promise<void>

  • Метод позволяет изменять папку элемента иерархического справочника.

    Parameters

    • id: string

    Returns Promise<void>