Class CardHelperHelper

Hierarchy

  • CardHelper

Variables

AllowAllCardPermissionFlags AllowAllFilePermissionFlags BusinessProcessTemplateTypeID BusinessProcessTemplateTypeName CalendarCalcMethodTypeID CalendarCalcMethodTypeName CalendarTypeCaption CalendarTypeID CalendarTypeName CalendarTypeTypeName CompletionOptionTypeID DefaultCalendarTypeTypeID DeletedTypeCaption DeletedTypeID DeletedTypeName FunctionRoleTypeID HelpSectionTypeCaption HelpSectionTypeID HelpSectionTypeName ProhibitAllCardPermissionFlags ProhibitAllFilePermissionFlags SequenceTypeCaption SequenceTypeID SequenceTypeName TemplateTypeCaption TemplateTypeID TemplateTypeName TwoFactorAuthTotpTypeID TwoFactorAuthTotpTypeName TwoFactorAuthUserSettingsTypeID TwoFactorAuthUserSettingsTypeName ViewTypeID WfSatelliteTypeID WfSatelliteTypeName WfTaskCardTypeID WfTaskCardTypeName WorkplaceTypeID cacheNewFileResponseKey filesToRestoreKey filesToWipeKey skipNewFileResponseCachingKey systemKeyPrefix userKeyPrefix userSettingsOnlyKey

Methods

executeTypeExtensions getFilesToSave grantAllPermissions hasFilesToSave isSystemKey isUserKey prohibitAllPermissions setAllCardPermissions

Methods

executeTypeExtensions

  • Выполняет расширения на типы карточек для заданного типа расширений.

    Returns

    Результат выполнения расширений.

    Parameters

    • type: CardTypeExtensionType

      Тип расширений, выполнение которых производится.

    • card: Card

      Основная проверяемая карточка (т.е. не файл и не задание).

    • cardMetadata: ICardMetadata

      Метаинформация по типам карточек, файлов и заданий.

    • executeAction: ((ctx: ICardTypeExtensionContext) => Promise<void>)

      Действие, выполняющее расширение.

    • Optional externalContext: unknown

      Внешний контекст расширения, в рамках которого выполняется расширение на тип карточки, или null, если такой контекст неизвестен.

    • Optional info: null | IStorage<unknown>

      Дополнительная информация, связанная с контекстом, или null, если дополнительная информация не задана.

    Returns Promise<ValidationResult>

getFilesToSave

  • Возвращает файлы которые были добавлены или содержимое которых было изменено.

    Returns

    Список файлов, которые были добавлены или содержимое которых было изменено.

    Parameters

    • card: Card

      Карточка, из которой достаются файлы.

    Returns CardFile[]

grantAllPermissions

  • Parameters

    • card: Card
    • removeOtherPermissions: boolean = false
    • excludeCards: boolean = false
    • excludeFiles: boolean = false
    • excludeTasks: boolean = false

    Returns void

hasFilesToSave

  • Возвращает признак того, что в заданной карточке присутствует хотя бы один файл, который был добавлен или содержимое которого было изменено.

    Returns

    true, если в заданной карточке присутствует хотя бы один файл, который был добавлен или содержимое которого было изменено; false в противном случае.

    Parameters

    • card: Card

      Карточка, для которой выполняется проверка.

    Returns boolean

isSystemKey

  • Определяет, является ли заданный ключ хранилища IStorage системным ключом.

    Parameters

    • key: string

    Returns boolean

isUserKey

  • Определяет, является ли заданный ключ хранилища IStorage пользовательским ключом.

    Parameters

    • key: string

    Returns boolean

prohibitAllPermissions

  • Parameters

    • card: Card
    • removeOtherPermissions: boolean = false
    • excludeCards: boolean = false
    • excludeFiles: boolean = false
    • excludeTasks: boolean = false

    Returns void

setAllCardPermissions

  • Parameters

    • card: Card
    • cardPermissions: CardPermissionFlags
    • filePermissions: CardPermissionFlags
    • removeOtherPermissions: boolean = false
    • excludeCards: boolean = false
    • excludeFiles: boolean = false
    • excludeTasks: boolean = false

    Returns void

Generated using TypeDoc