Class CardGetFileContentRequest

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

Hierarchy

Implements

Constructors

constructor

Properties - Static Keys

cardIdKey cardTypeIdKey cardTypeNameKey fileIdKey fileNameKey fileTypeIdKey fileTypeNameKey infoKey suggestFileNameForVersionKey systemMethodKey versionRowIdKey

Accessors

cardId cardTypeId cardTypeName fileId fileName fileTypeId fileTypeName info method suggestFileNameForVersion versionRowId

Methods

clean clone ensureCacheResolved getStorage getStorageSettings isValid notifyStorageUpdated removeSystemInfo removeUserInfo tryGetInfo validate

Constructors

constructor

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

    Parameters

    • storage: IStorage<unknown> = {}

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

    Returns CardGetFileContentRequest

Static Keys Properties

Static Readonly cardIdKey

cardIdKey: "CardID" = 'CardID'

Static Readonly cardTypeIdKey

cardTypeIdKey: "CardTypeID" = 'CardTypeID'

Static Readonly cardTypeNameKey

cardTypeNameKey: "CardTypeName" = 'CardTypeName'

Static Readonly fileIdKey

fileIdKey: "FileID" = 'FileID'

Static Readonly fileNameKey

fileNameKey: "FileName" = 'FileName'

Static Readonly fileTypeIdKey

fileTypeIdKey: "FileTypeID" = 'FileTypeID'

Static Readonly fileTypeNameKey

fileTypeNameKey: "FileTypeName" = 'FileTypeName'

Static Readonly infoKey

infoKey: "Info" = 'Info'

Static Readonly suggestFileNameForVersionKey

suggestFileNameForVersionKey: "SuggestFileNameForVersion" = 'SuggestFileNameForVersion'

Static Readonly systemMethodKey

systemMethodKey: string = ...

Static Readonly versionRowIdKey

versionRowIdKey: "VersionRowID" = 'VersionRowID'

Accessors

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<unknown>

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

    Returns IStorage<unknown>

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

  • Parameters

    Returns void

method

suggestFileNameForVersion

  • get suggestFileNameForVersion(): boolean

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

    Returns boolean

  • set suggestFileNameForVersion(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

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

    Returns void

clone

ensureCacheResolved

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

    Returns void

getStorage

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

    Returns

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

    Returns IStorage<unknown>

getStorageSettings

isValid

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

    Returns

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

    Returns boolean

notifyStorageUpdated

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

    Returns void

removeSystemInfo

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

    Returns void

removeUserInfo

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

    Returns void

tryGetInfo

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

    Returns

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

    Returns null | IStorage<unknown>

validate

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

    Returns

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

    Returns ValidationResult

Generated using TypeDoc