TESSA Web API
    Preparing search index...

    Class CardFileContentSource

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

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    constructor

    Properties - Other

    cachedMemberChanged fieldChanged

    Properties - Static Keys

    cardIdKey cardTypeIdKey fileIdKey fileTypeNameKey originalVersionRowIdKey storeSourceKey storeViaContentRequestKey versionRowIdKey

    Accessors

    cachedMembers cardId cardTypeId fileId fileTypeName isObservable originalVersionRowId storeSource storeViaContentRequest versionRowId

    Methods

    clean clone ensureCacheResolved getStorage getStorageSettings isValid notifyStorageUpdated validate

    Constructors

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

      Parameters

      • storage: IStorage = {}

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

      Returns CardFileContentSource

    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'
    fileIdKey: "FileID" = 'FileID'
    fileTypeNameKey: "FileTypeName" = 'FileTypeName'
    originalVersionRowIdKey: "OriginalVersionRowID" = 'OriginalVersionRowID'
    storeSourceKey: "StoreSource" = 'StoreSource'
    storeViaContentRequestKey: "StoreViaContentRequest" = 'StoreViaContentRequest'
    versionRowIdKey: "VersionRowID" = 'VersionRowID'

    Accessors

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

      Returns ReadonlyMap<string, unknown>

    • get cardId(): string

      Идентификатор карточки, в которой содержится файл.

      Returns string

    • set cardId(value: string): void

      Parameters

      • value: string

      Returns void

    • get cardTypeId(): null | string

      Идентификатор типа карточки, в которой содержится файл, или null, если идентификатор типа карточки не передаётся в запросы.

      Returns null | string

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

      Parameters

      • value: null | string

      Returns void

    • get fileId(): string

      Идентификатор файла.

      Returns string

    • set fileId(value: string): void

      Parameters

      • value: string

      Returns void

    • get fileTypeName(): null | string

      Имя типа файла, передаваемое в запросы на загрузку содержимого CardGetFileContentRequest, в запросы на получение списка версий CardGetFileVersionsRequest, в запросы на загрузку списка подписей CardRequestTypes.GetVersionSignatures, а также в запрос CardGetFileContentRequest при сохранении карточки (если указан признак storeViaContentRequest).

      Если указано null/пустая строка, то значение не устанавливается в запросе при сохранении карточки, а в остальных случаях оно определяется собственно типом файла CardFile.

      Returns null | string

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

      Parameters

      • value: null | string

      Returns void

    • get isObservable(): boolean

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

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

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

      Returns boolean

    • set isObservable(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get originalVersionRowId(): null | string

      Идентификатор исходной версии файла, к которой относится источник контента, или null, если источник относится к любой из версий.

      При указании флага storeViaContentRequest значение не передаётся в запрос на загрузку содержимого файла при сохранении.

      Returns null | string

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

      Parameters

      • value: null | string

      Returns void

    • get storeSource(): number

      Местоположение контента версии файла.

      При указании флага storeViaContentRequest значение не передаётся в запрос на загрузку содержимого файла при сохранении.

      Returns number

    • set storeSource(value: number): void

      Parameters

      • value: number

      Returns void

    • get storeViaContentRequest(): boolean

      Признак того, что при сохранении карточки с таким файлом его содержимое запрашивается выполнением запроса CardGetFileContentRequest. Если указан как false (по умолчанию), то содержимое копируется напрямую в хранилище контента.

      Для таких файлов, как и для любых других, необходимо указать размер CardFile.Size. Актуальный размер из ответа на запрос CardGetFileContentResponse.Size будет установлен после успешного сохранения.

      Returns boolean

    • set storeViaContentRequest(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get versionRowId(): string

      Идентификатор версии файла.

      Returns string

    • set versionRowId(value: string): void

      Parameters

      • value: string

      Returns void

    Methods

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

      Returns void

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

      Returns void

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

      Returns IStorage

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

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

      Returns boolean

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

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

      Returns void

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

      Returns ValidationResult

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties - Other
    Properties - Static Keys
    Accessors
    Methods