Class KrToken

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

Hierarchy (View Summary)

Implements

Constructors

constructor

Properties - Other

cachedMemberChanged fieldChanged

Properties - Static Keys

cardIdKey cardVersionKey expiryDateKey extendedCardSettingsKey infoKey krTokenKey permissionsKey permissionsVersionKey serverOnlyKey signatureKey

Accessors

cachedMembers cardId cardVersion expiryDate extendedCardSettings info isObservable permissions permissionsVersion signature

Methods

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

Constructors

constructor

Properties - Other

ReadonlycachedMemberChanged

cachedMemberChanged: EventHandler<
    { fieldName: string; newValue: unknown; oldValue: unknown },
>

ReadonlyfieldChanged

fieldChanged: EventHandler<
    { fieldName: string; newValue: unknown; oldValue: unknown },
>

Properties - Static Keys

Static ReadonlycardIdKey

cardIdKey: "CardID" = 'CardID'

Static ReadonlycardVersionKey

cardVersionKey: "CardVersion" = 'CardVersion'

Static ReadonlyexpiryDateKey

expiryDateKey: "ExpiryDate" = 'ExpiryDate'

Static ReadonlyextendedCardSettingsKey

extendedCardSettingsKey: "ExtendedCardSettings" = 'ExtendedCardSettings'

Static ReadonlyinfoKey

infoKey: "Info" = 'Info'

Static ReadonlykrTokenKey

krTokenKey: "KrToken" = 'KrToken'

Static ReadonlypermissionsKey

permissionsKey: "Permissions" = 'Permissions'

Static ReadonlypermissionsVersionKey

permissionsVersionKey: "PermissionsVersion" = 'PermissionsVersion'

Static ReadonlyserverOnlyKey

serverOnlyKey: "ServerOnly" = 'ServerOnly'

Static ReadonlysignatureKey

signatureKey: "Signature" = 'Signature'

Accessors

cachedMembers

  • get cachedMembers(): ReadonlyMap<string, unknown>

    Returns ReadonlyMap<string, unknown>

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

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

    Returns IStorage

  • set info(value: IStorage): void

    Parameters

    Returns void

isObservable

  • get isObservable(): boolean

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

    Если значение этого свойства равно true, то объект класса может быть подписан на изменения, и соответствующие обработчики будут вызываться при каждом изменении состояния объекта.

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

    Returns boolean

  • set isObservable(value: boolean): void

    Parameters

    • value: boolean

    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

  • clean(): void

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

    Returns void

clone

  • clone(): KrToken

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

    Returns KrToken

ensureCacheResolved

  • ensureCacheResolved(): void

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

    Returns void

getStorage

  • getStorage(): IStorage

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

    Returns IStorage

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

getStorageSettings

hasPermission

  • hasPermission(krPermission: KrPermissionFlagDescriptor): boolean

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

    Parameters

    Returns boolean

isValid

  • isValid(): boolean

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

    Returns boolean

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

notifyStorageUpdated

  • notifyStorageUpdated(): void

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

    Returns void

setInfo

  • setInfo(cardInfo: IStorage): void

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

    Parameters

    Returns void

tryGetExtendedCardSettings

tryGetInfo

  • tryGetInfo(): null | IStorage

    Returns null | IStorage

validate

  • validate(): ValidationResult

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

    Returns ValidationResult

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

Staticcontains

  • contains(cardInfo: IStorage): boolean

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

    Parameters

    Returns boolean

Staticremove

  • remove(cardInfo: IStorage): boolean

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

    Parameters

    Returns boolean

StatictryGet

  • tryGet(cardInfo: IStorage): null | KrToken

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

    Parameters

    Returns null | KrToken

Settings

Member Visibility

On This Page

Constructors
Properties - Other
Properties - Static Keys
Accessors
Methods