Class CardGetFileContentRequest

Запрос на получение контента версии файла, прикреплённого к карточке, от сервиса карточек.

Hierarchy (View Summary, Expand)

Implements

Constructors

constructor

Properties - Other

cachedMemberChanged fieldChanged

Properties - Static Keys

cardIdKey cardTypeIdKey cardTypeNameKey fileIdKey fileNameKey fileTypeIdKey fileTypeNameKey infoKey suggestFileNameForVersionKey supportContentTokenKey systemMethodKey versionRowIdKey

Accessors

cachedMembers cardId cardTypeId cardTypeName fileId fileName fileTypeId fileTypeName info isObservable method suggestFileNameForVersion supportContentToken versionRowId

Methods

clean clone ensureCacheResolved getStorage getStorageSettings isValid notifyStorageUpdated removeSystemInfo removeUserInfo tryGetInfo validate

Constructors

constructor

  • new CardGetFileContentRequest(storage?: IStorage): CardGetFileContentRequest

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

    Parameters

    • storage: IStorage = {}

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

    Returns CardGetFileContentRequest

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 ReadonlycardTypeIdKey

cardTypeIdKey: "CardTypeID" = 'CardTypeID'

Static ReadonlycardTypeNameKey

cardTypeNameKey: "CardTypeName" = 'CardTypeName'

Static ReadonlyfileIdKey

fileIdKey: "FileID" = 'FileID'

Static ReadonlyfileNameKey

fileNameKey: "FileName" = 'FileName'

Static ReadonlyfileTypeIdKey

fileTypeIdKey: "FileTypeID" = 'FileTypeID'

Static ReadonlyfileTypeNameKey

fileTypeNameKey: "FileTypeName" = 'FileTypeName'

Static ReadonlyinfoKey

infoKey: "Info" = 'Info'

Static ReadonlysuggestFileNameForVersionKey

suggestFileNameForVersionKey: "SuggestFileNameForVersion" = 'SuggestFileNameForVersion'

Static ReadonlysupportContentTokenKey

supportContentTokenKey: "SupportContentToken" = 'SupportContentToken'

Static ReadonlysystemMethodKey

systemMethodKey: string = ...

Static ReadonlyversionRowIdKey

versionRowIdKey: "VersionRowID" = 'VersionRowID'

Accessors

cachedMembers

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

    Returns ReadonlyMap<string, unknown>

cardId

  • get cardId(): null | string

    Идентификатор запрашиваемой карточки или null, если запрашивается виртуальная карточка, идентификатор которой задаётся другим способом.

    Returns null | string

  • set cardId(value: null | string): void

    Parameters

    • value: null | string

    Returns void

cardTypeId

  • get cardTypeId(): null | string

    Идентификатор типа карточки. Значение необязательно для заполнения.

    Returns null | string

  • set cardTypeId(value: null | string): void

    Parameters

    • value: null | string

    Returns void

cardTypeName

  • get cardTypeName(): null | string

    Имя типа карточки. Значение необязательно для заполнения.

    Returns null | string

  • set cardTypeName(value: null | string): void

    Parameters

    • value: null | string

    Returns void

fileId

  • get fileId(): null | string

    Идентификатор файла, информация по которому запрашивается, или null, если информация запрашивается по виртуальному файлу, идентификатор которого задаётся другим способом. По умолчанию значение равно null.

    Returns null | string

  • set fileId(value: null | string): void

    Parameters

    • value: null | string

    Returns void

fileName

  • get fileName(): null | string

    Имя файла, информация по которому запрашивается. По умолчанию значение равно null.

    Returns null | string

  • set fileName(value: null | string): void

    Parameters

    • value: null | string

    Returns void

fileTypeId

  • get fileTypeId(): null | string

    Идентификатор типа файла. Значение необязательно для заполнения.

    Returns null | string

  • set fileTypeId(value: null | string): void

    Parameters

    • value: null | string

    Returns void

fileTypeName

  • get fileTypeName(): null | string

    Имя типа файла. Значение необязательно для заполнения.

    Returns null | string

  • set fileTypeName(value: null | string): void

    Parameters

    • value: null | string

    Returns void

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

method

suggestFileNameForVersion

  • get suggestFileNameForVersion(): boolean

    Признак, отражающий рекомендацию по возврату предпочитаемого имени версии файла, которое записывается в ответе на запрос CardGetFileContentResponse. Окончательное решение о необходимости возврата предпочитаемого имени файла/версии принимается серверной стороной.

    Returns boolean

  • set suggestFileNameForVersion(value: boolean): void

    Parameters

    • value: boolean

    Returns void

supportContentToken

  • get supportContentToken(): boolean

    Флаг указывает, что поддерживается загрузка контента файла по ссылке. (выполняется GET-запрос на отдельный метод контроллера по ссылке, которая содержит токен сессии и токен контента файла).

    Returns boolean

  • set supportContentToken(value: boolean): void

    Parameters

    • value: boolean

    Returns void

versionRowId

  • get versionRowId(): null | string

    Идентификатор версии файла, контент которого запрашивается, или null, если запрашивается виртуальная версия файла, идентификатор которой задаётся другим способом. По умолчанию значение равно null.

    Returns null | string

  • set versionRowId(value: null | string): void

    Parameters

    • value: null | string

    Returns void

Methods

clean

  • clean(): void

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

    Returns void

clone

ensureCacheResolved

  • ensureCacheResolved(): void

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

    Returns void

getStorage

  • getStorage(): IStorage

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

    Returns IStorage

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

getStorageSettings

isValid

  • isValid(): boolean

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

    Returns boolean

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

notifyStorageUpdated

  • notifyStorageUpdated(): void

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

    Returns void

removeSystemInfo

  • removeSystemInfo(): void

    Удаляет системную информацию, которая может располагаться в любом месте в хранилище текущего объекта и может быть найдена по ключам с префиксом StorageHelper.systemKeyPrefix.

    Returns void

removeUserInfo

  • removeUserInfo(): void

    Удаляет пользовательскую информацию, которая может располагаться в любом месте в хранилище текущего объекта и может быть найдена по ключам с префиксом StorageHelper.userKeyPrefix.

    Returns void

tryGetInfo

  • tryGetInfo(): null | IStorage

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

    Returns null | IStorage

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

validate

  • validate(): ValidationResult

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

    Returns ValidationResult

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

Settings

Member Visibility

On This Page

Constructors
Properties - Other
Properties - Static Keys
Accessors
Methods
MMNEPVFCICPMFPCPTTAAATR