Class CardGetFileContentResponse

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

Hierarchy (View Summary, Expand)

Implements

Constructors

constructor

Properties - Other

cachedMemberChanged fieldChanged contentTokenKey

Properties - Static Keys

fileNameKey infoKey validationResultKey

Accessors

cachedMembers content contentToken fileName hasContent info isObservable size validationResult

Methods

clean clone ensureCacheResolved getStorage getStorageSettings isValid notifyStorageUpdated removeSystemInfo removeUserInfo setContent tryGetInfo tryGetSuggestedFileNameFromInfo tryGetValidationResult validate tryGetFileNameFromContentDisposition

Constructors

constructor

  • new CardGetFileContentResponse(storage?: IStorage): CardGetFileContentResponse

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

    Parameters

    • storage: IStorage = {}

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

    Returns CardGetFileContentResponse

Properties - Other

ReadonlycachedMemberChanged

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

ReadonlyfieldChanged

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

Static ReadonlycontentTokenKey

contentTokenKey: "ContentToken" = 'ContentToken'

Properties - Static Keys

Static ReadonlyfileNameKey

fileNameKey: "FileName" = 'FileName'

Static ReadonlyinfoKey

infoKey: "Info" = 'Info'

Static ReadonlyvalidationResultKey

validationResultKey: "ValidationResult" = 'ValidationResult'

Accessors

cachedMembers

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

    Returns ReadonlyMap<string, unknown>

content

  • get content(): null | Blob

    Запрошенный контент.

    Returns null | Blob

contentToken

  • get contentToken(): null | string

    Токен контента файла.

    Returns null | string

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

    Parameters

    • value: null | string

    Returns void

fileName

  • get fileName(): null | string

    Имя файла.

    Returns null | string

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

    Parameters

    • value: null | string

    Returns void

hasContent

  • get hasContent(): boolean

    Признак того, что запрошенный контент может быть получен.

    Returns boolean

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

size

  • get size(): number

    Длина в байтах для запрошенного контента.

    Returns number

validationResult

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

setContent

  • setContent(content: Blob, fileName?: null | string): void

    Parameters

    • content: Blob
    • fileName: null | string = null

    Returns void

tryGetInfo

  • tryGetInfo(): null | IStorage

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

    Returns null | IStorage

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

tryGetSuggestedFileNameFromInfo

  • tryGetSuggestedFileNameFromInfo(): null | string

    Returns null | string

tryGetValidationResult

  • tryGetValidationResult(): null | ValidationStorageResultBuilder

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

    Returns null | ValidationStorageResultBuilder

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

validate

  • validate(): ValidationResult

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

    Returns ValidationResult

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

StatictryGetFileNameFromContentDisposition

  • tryGetFileNameFromContentDisposition(
        contentDisposition: null | string,
    ): null | string

    Parameters

    • contentDisposition: null | string

    Returns null | string

Settings

Member Visibility

On This Page

Constructors
Properties - Other
Properties - Static Keys
Accessors
Methods
MMNEPVFCICPMFPCPTTAAATR