Class CardSectionPermissionInfo

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

Hierarchy

Constructors

constructor

Properties - Other

name

Properties - Static Keys

fieldPermissionsKey rowsKey sectionPermissionsKey

Accessors

fieldPermissions rows sectionPermissions type

Methods

clean ensureCacheResolved getStorage getStorageSettings isEmpty isValid notifyStorageUpdated setFieldPermissions setSectionPermissions tryGetFieldPermissions tryGetRows validate

Constructors

constructor

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

    Parameters

    • name: string

      Имя секции.

    • storage: IStorage<unknown> = {}

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

    Returns CardSectionPermissionInfo

Other Properties

Readonly name

name: string

Имя секции.

Static Keys Properties

Static Readonly fieldPermissionsKey

fieldPermissionsKey: "FieldPermissions" = 'FieldPermissions'

Static Readonly rowsKey

rowsKey: "Rows" = 'Rows'

Static Readonly sectionPermissionsKey

sectionPermissionsKey: "SectionPermissions" = 'SectionPermissions'

Accessors

fieldPermissions

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

  • Права доступа на отдельные поля секции.

    Returns TypedStorageMap<Int, number>

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

  • Parameters

    Returns void

rows

sectionPermissions

type

  • get type(): CardSectionType

  • Тип секции карточки. Не содержится в пакете и вычисляется на основании наличия в пакете определённых полей.

    Returns CardSectionType

  • set type(value: CardSectionType): void

  • Parameters

    Returns void

Methods

clean

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

    Returns void

ensureCacheResolved

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

    Returns void

getStorage

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

    Returns

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

    Returns IStorage<unknown>

getStorageSettings

isEmpty

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

    Returns

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

    Returns boolean

isValid

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

    Returns

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

    Returns boolean

notifyStorageUpdated

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

    Returns void

setFieldPermissions

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

    Returns

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

    Parameters

    • fieldName: string

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

    • flags: CardPermissionFlags

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

    • overwrite: boolean = false

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

    Returns CardSectionPermissionInfo

setSectionPermissions

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

    Returns

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

    Parameters

    • flags: CardPermissionFlags

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

    • overwrite: boolean = false

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

    Returns CardSectionPermissionInfo

tryGetFieldPermissions

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

    Returns

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

    Returns null | TypedStorageMap<Int, number>

tryGetRows

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

    Returns

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

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

validate

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

    Returns

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

    Returns ValidationResult

Generated using TypeDoc