Class KrToken

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

Hierarchy

Implements

Constructors

constructor

Properties - Static Keys

cardIdKey cardVersionKey expiryDateKey extendedCardSettingsKey infoKey krTokenKey permissionsKey permissionsVersionKey serverOnlyKey signatureKey

Accessors

cardId cardVersion expiryDate extendedCardSettings info permissions permissionsVersion signature

Methods

clean clone ensureCacheResolved getStorage getStorageSettings hasPermission isValid notifyStorageUpdated setInfo tryGetExtendedCardSettings tryGetInfo validate contains remove tryGet

Constructors

constructor

Static Keys Properties

Static Readonly cardIdKey

cardIdKey: "CardID" = 'CardID'

Static Readonly cardVersionKey

cardVersionKey: "CardVersion" = 'CardVersion'

Static Readonly expiryDateKey

expiryDateKey: "ExpiryDate" = 'ExpiryDate'

Static Readonly extendedCardSettingsKey

extendedCardSettingsKey: "ExtendedCardSettings" = 'ExtendedCardSettings'

Static Readonly infoKey

infoKey: "Info" = 'Info'

Static Readonly krTokenKey

krTokenKey: "KrToken" = 'KrToken'

Static Readonly permissionsKey

permissionsKey: "Permissions" = 'Permissions'

Static Readonly permissionsVersionKey

permissionsVersionKey: "PermissionsVersion" = 'PermissionsVersion'

Static Readonly serverOnlyKey

serverOnlyKey: "ServerOnly" = 'ServerOnly'

Static Readonly signatureKey

signatureKey: "Signature" = 'Signature'

Accessors

cardId

  • get cardId(): string

  • Идентификатор карточки. Если равен Guid.Empty, то считается, что токен подписан для любой карточки, что актуально, прежде всего, для алгоритма создания карточки cardRepository.New().

    Returns string

  • set cardId(value: string): void

  • Parameters

    • value: string

    Returns void

cardVersion

  • get cardVersion(): number

  • Номер версии карточки. Если равен CardComponentHelper.DoNotCheckVersion, то считается, что токен подписан для любой версии карточки.

    Returns number

  • set cardVersion(value: number): void

  • Parameters

    • value: number

    Returns void

expiryDate

  • get expiryDate(): string

  • Дата и время истечения токена.

    Returns string

  • set expiryDate(value: string): void

  • Parameters

    • value: string

    Returns void

extendedCardSettings

info

  • get info(): IStorage<unknown>

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

    Returns IStorage<unknown>

  • set info(value: IStorage<unknown>): void

  • Parameters

    Returns void

permissions

permissionsVersion

  • get permissionsVersion(): number

  • Returns number

  • set permissionsVersion(value: number): void

  • Parameters

    • value: number

    Returns void

signature

  • get signature(): string

  • Подпись токена, которая гарантирует его валидность. Подписываются все другие поля, кроме собственно подписи.

    Returns string

  • set signature(value: string): void

  • Parameters

    • value: string

    Returns void

Methods

clean

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

    Returns void

clone

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

    Returns KrToken

ensureCacheResolved

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

    Returns void

getStorage

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

    Returns

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

    Returns IStorage<unknown>

getStorageSettings

hasPermission

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

    Parameters

    Returns boolean

isValid

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

    Returns

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

    Returns boolean

notifyStorageUpdated

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

    Returns void

setInfo

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

    Parameters

    Returns void

tryGetExtendedCardSettings

tryGetInfo

  • Returns null | IStorage<unknown>

validate

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

    Returns

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

    Returns ValidationResult

Static contains

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

    Parameters

    Returns boolean

Static remove

  • Удаляет информацию по токену безопасности KrToken для заданного хранилища cardInfo. Возвращает признак того, что токен присутствовал и был удалён.

    Parameters

    Returns boolean

Static tryGet

  • Возвращает информацию по токену безопасности KrToken или null, если такая информация не была установлена.

    Parameters

    Returns null | KrToken

Generated using TypeDoc