TESSA Web API
    Preparing search index...

    Class CardGetFileContentRequest

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

    Hierarchy (View Summary)

    Implements

    Index

    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

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

      Parameters

      • storage: IStorage = {}

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

      Returns CardGetFileContentRequest

    Properties - Other

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

    Properties - Static Keys

    cardIdKey: "CardID" = 'CardID'
    cardTypeIdKey: "CardTypeID" = 'CardTypeID'
    cardTypeNameKey: "CardTypeName" = 'CardTypeName'
    fileIdKey: "FileID" = 'FileID'
    fileNameKey: "FileName" = 'FileName'
    fileTypeIdKey: "FileTypeID" = 'FileTypeID'
    fileTypeNameKey: "FileTypeName" = 'FileTypeName'
    infoKey: "Info" = 'Info'
    suggestFileNameForVersionKey: "SuggestFileNameForVersion" = 'SuggestFileNameForVersion'
    supportContentTokenKey: "SupportContentToken" = 'SupportContentToken'
    systemMethodKey: string = ...
    versionRowIdKey: "VersionRowID" = 'VersionRowID'

    Accessors

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

      Returns ReadonlyMap<string, unknown>

    • get cardId(): null | string

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

      Returns null | string

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

      Parameters

      • value: null | string

      Returns void

    • get cardTypeId(): null | string

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

      Returns null | string

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

      Parameters

      • value: null | string

      Returns void

    • get cardTypeName(): null | string

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

      Returns null | string

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

      Parameters

      • value: null | string

      Returns void

    • get fileId(): null | string

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

      Returns null | string

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

      Parameters

      • value: null | string

      Returns void

    • get fileName(): null | string

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

      Returns null | string

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

      Parameters

      • value: null | string

      Returns void

    • get fileTypeId(): null | string

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

      Returns null | string

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

      Parameters

      • value: null | string

      Returns void

    • get fileTypeName(): null | string

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

      Returns null | string

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

      Parameters

      • value: null | string

      Returns void

    • get info(): IStorage

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

      Returns IStorage

    • set info(value: IStorage): void

      Parameters

      Returns void

    • get isObservable(): boolean

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

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

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

      Returns boolean

    • set isObservable(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get suggestFileNameForVersion(): boolean

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

      Returns boolean

    • set suggestFileNameForVersion(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get supportContentToken(): boolean

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

      Returns boolean

    • set supportContentToken(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get versionRowId(): null | string

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

      Returns null | string

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

      Parameters

      • value: null | string

      Returns void

    Methods

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

      Returns void

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

      Returns void

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

      Returns IStorage

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

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

      Returns boolean

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

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

      Returns void

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

      Returns void

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

      Returns void

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

      Returns null | IStorage

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

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

      Returns ValidationResult

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties - Other
    Properties - Static Keys
    Accessors
    Methods