Class CardPermissionInfo

Содержит права доступа на карточку и её секции.

Hierarchy

Implements

Constructors

constructor

Properties - Static Keys

cardPermissionsKey filePermissionsKey sectionsKey

Accessors

cardPermissions filePermissions resolver sections

Methods

clean clear clone ensureCacheResolved getStorage getStorageSettings isEmpty isValid merge notifyStorageUpdated setCardPermissions setFilePermissions tryGetFilePermissions tryGetSections validate

Constructors

constructor

  • Создаёт экземпляр класса с указанием хранилища (или пустое хранилище по умолчанию), декоратором для которого является создаваемый объект.

    Parameters

    • storage: IStorage<unknown> = {}

      Хранилище, декоратором для которого является создаваемый объект.

    Returns CardPermissionInfo

Static Keys Properties

Static Readonly cardPermissionsKey

cardPermissionsKey: "CardPermissions" = 'CardPermissions'

Static Readonly filePermissionsKey

filePermissionsKey: "FilePermissions" = 'FilePermissions'

Static Readonly sectionsKey

sectionsKey: "Sections" = 'Sections'

Accessors

cardPermissions

filePermissions

  • get filePermissions(): TypedStorageMap<Int, number>

  • Права доступа на файлы, прикреплённые к карточке.

    Returns TypedStorageMap<Int, number>

  • set filePermissions(value: TypedStorageMap<Int, number>): void

  • Parameters

    Returns void

resolver

  • get resolver(): ICardPermissionResolver

  • Объект, осуществляющий поиск и кэширование прав доступа для полей и строк.

    Returns ICardPermissionResolver

sections

Methods

clean

  • Выполняет очистку хранилища от избыточных данных.

    Returns void

clear

  • Удаляет всю информацию о правах доступа.

    Returns void

clone

  • Создает новый объект, который является копией текущего экземпляра.

    Returns CardPermissionInfo

ensureCacheResolved

  • Выполняет резолв кеша декораторов для данных объекта-хранилища.

    Returns void

getStorage

  • Возвращает хранилище IStorage, декоратором для которого является текущий объект.

    Returns

    Хранилище IStorage, декоратором для которого является текущий объект.

    Returns IStorage<unknown>

getStorageSettings

isEmpty

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

    Returns

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

    Returns boolean

isValid

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

    Returns

    true, если объект прошёл проверку на валидность; false в противном случае.

    Returns boolean

merge

  • Копирует права доступа из заданного объекта, выполняя слияние с текущим объектом с перезаписью уже существующих прав.

    Parameters

    • permissionInfo: CardPermissionInfo

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

    Returns void

notifyStorageUpdated

  • Метод, уведомляющий объект о наличии изменений в его хранилище.

    Returns void

setCardPermissions

  • Устанавливает заданные разрешения или запреты для карточки.

    Returns

    Текущий объект для цепочки вызовов.

    Parameters

    • flags: CardPermissionFlags

      Устанавливаемые разрешения или запреты. Для указания разрешения задавайте только флаг Allow, а для запрета - только флаг Prohibit.

    • overwrite: boolean = false

      Признак того, что требуется заменить все имеющиеся разрешения и запреты.

    Returns CardPermissionInfo

setFilePermissions

  • Устанавливает заданные разрешения или запреты для файла с идентификатором fileId.

    Returns

    Текущий объект для цепочки вызовов.

    Parameters

    • fileId: string

      Идентификатор файла, для которого устанавливается разрешение или запрет.

    • flags: CardPermissionFlags

      станавливаемые разрешения или запреты. Для указания разрешения задавайте только флаг Allow, а для запрета - только флаг Prohibit.

    • overwrite: boolean = false

      Признак того, что требуется заменить все имеющиеся разрешения и запреты.

    Returns CardPermissionInfo

tryGetFilePermissions

  • Возвращает права доступа на файлы, прикреплённые к карточке, или null, если права ещё не были заданы.

    Returns

    Права доступа на файлы, прикреплённые к карточке, или null, если права ещё не были заданы.

    Returns null | TypedStorageMap<Int, number>

tryGetSections

  • Возвращает права доступа на отдельные секции карточки или null, если права ещё не были заданы.

    Returns

    Права доступа на отдельные секции карточки или null, если права ещё не были заданы.

    Returns null | StorageMap<CardSectionPermissionInfo, IStorage<unknown>>

validate

  • Выполняет валидацию текущего объекта и всех его дочерних объектов.

    Returns

    Объект, выполняющий построение результата валидации.

    Returns ValidationResult

Generated using TypeDoc