ICardGetExtensionContext - интерфейс

Контекст процесса получения карточки.

Definition

Пространство имён: Tessa.Cards.Extensions
Сборка: Tessa (в Tessa.dll) Версия: 4.0.4
C#
public interface ICardGetExtensionContext : ICardRequestExtensionContext<CardGetRequest, CardGetResponse>, 
	ICardExtensionContext, ICardTypeExtensionContext, ITraceableInfoExtensionContext, ITraceableExtensionContext, IExtensionContext
Implements
ICardExtensionContext, ICardRequestExtensionContextCardGetRequest, CardGetResponse, ICardTypeExtensionContext, IExtensionContext, ITraceableExtensionContext, ITraceableInfoExtensionContext

Свойства

CancellationToken Объект, посредством которого можно отменить асинхронную задачу.
(Унаследован от IExtensionContext)
CardMetadataМетаинформация по типам карточек, известным в системе.
(Унаследован от ICardExtensionContext)
CardType

Тип карточки или null, если тип карточки неизвестен.

Данное свойство следует устанавливать, если оно еще не задано, но необходимо предоставить информацию о типе в цепочке расширений. Например, в методе [ICardGetExtension.BeforeRequest] можно задать тип, а в методах [ICardGetExtension.BeforeRequestWhenTypeResolved] или [ICardGetExtension.AfterRequest] проверить его напрямую. Также это может пригодиться при проверке типа методом [CardExtensions.WhenCardTypes].


(Унаследован от ICardTypeExtensionContext)
CardTypeIsVerified

Признак того, что заданный тип карточки является корректным в рамках текущего запроса. Если тип не является корректным, то перед выполнением метода BeforeRequestWhenTypeResolved он будет определен из базы данных по идентификатору карточки, переданныму в запросе.

Поле используется только на сервере, в клиентской части его использование бессмысленно. Если запрос пришел с клиента, то при создании контекста устанавливается значение false. Ручное изменение свойств [CardType] и [CardTypeName] автоматически установит его как true.


(Унаследован от ICardTypeExtensionContext)
CardTypeName

Уникальное имя типа карточки или null, если тип карточки неизвестен. Имя может не соответствовать действительному типу в метаинформации.

Данное свойство следует устанавливать, если оно еще не задано, но необходимо предоставить информацию о типе в цепочке расширений. Например, в методе [ICardGetExtension.BeforeRequest] можно задать тип, а в методах [ICardGetExtension.BeforeRequestWhenTypeResolved] или [ICardGetExtension.AfterRequest] проверить его напрямую. Также это может пригодиться при проверке типа методом [CardExtensions.WhenCardTypes].


(Унаследован от ICardTypeExtensionContext)
DbScope Объект, обеспечивающий взаимодействие с базой данных. Значение равно null на клиенте и не равно null на сервере.
(Унаследован от ICardExtensionContext)
EnableTracing Признак того, что для текущего метода расширений разрешена запись сообщения трассировки при включённой в системе трассировке. Установка значения равным false позволяет запретить запись сообщения, например, для реализации метода, которая по умолчанию не выполняет полезной работы. При отключённой сортировке значение равно false.
(Унаследован от ITraceableExtensionContext)
Info Дополнительная информация, связанная с контекстом расширений.
(Унаследован от ITraceableInfoExtensionContext)
MethodСпособ загрузки карточки.
RequestЗапрос на взаимодействие с карточкой.
(Унаследован от ICardRequestExtensionContextTRequest, TResponse)
RequestIsSuccessful Признак того, что процесс взаимодействия с карточкой завершился успешно. Можно использовать в расширениях, выполняющихся после запроса к сервису.
(Унаследован от ICardExtensionContext)
Response Ответ на запрос по взаимодействию с карточкой. Если свойство установлено перед выполнением взаимодействия с карточкой стандартными средствами, то такое взаимодействие не производится.
(Унаследован от ICardRequestExtensionContextTRequest, TResponse)
SessionСессия пользователя, для которого выполняется процесс взаимодействия с карточкой.
(Унаследован от ICardExtensionContext)
ValidationResult Объект, выполняющий построение результата валидации. Может использоваться для того, чтобы запретить выполнение процесса стандартными средствами.
(Унаследован от ITraceableExtensionContext)

Методы расширения

AddCardIDToLoadSignatures Добавляет идентификатор карточки в список идентификаторов, для которых будут загружены подписи для файлов, помимо текущей загруженной карточки. Используйте для виртуальных файлов, относящихся к другим карточкам, которые добавлены в загруженную карточку. Подписи загружаются в CardGetExtension.AfterRequest на этапе ExtensionStage.Platform, поэтому список идентификаторов должен быть установлен раньше. Возвращает признак того, что идентификатор был добавлен, т.к. отсутствовал в списке.
(Определяется CardRequestExtensions)
CancelOpeningAsync Отменяет открытие загружаемой карточки, при необходимости создаётся и настраивается объект ответа на запрос.
(Определяется CardExtensionContextExtensions)
CardTypeIs Возвращает признак того, что идентификатор типа карточки равен заданному значению.
(Определяется CardExtensionContextExtensions)
CardTypeIs Возвращает признак того, что идентификатор типа карточки равен одному из заданных значений.
(Определяется CardExtensionContextExtensions)
CardTypeIs Возвращает признак того, что идентификатор типа карточки равен одному из заданных значений.
(Определяется CardExtensionContextExtensions)
CardTypeIs Возвращает признак того, что имя типа карточки (свойство CardTypeName) равно одному из заданных значений. Пользуясь данным методом необходимо учитывать, что поле CardType может быть равным null.
(Определяется CardExtensionContextExtensions)
CardTypeIs Возвращает признак того, что имя типа карточки (свойство CardTypeName) равно заданному значению. Пользуясь данным методом необходимо учитывать, что поле CardType может быть равным null.
(Определяется CardExtensionContextExtensions)
CardTypeIs Возвращает признак того, что имя типа карточки (свойство CardTypeName) равно одному из заданных значений. Пользуясь данным методом необходимо учитывать, что поле CardType может быть равным null.
(Определяется CardExtensionContextExtensions)
CardTypeIs Возвращает признак того, что идентификатор типа карточки равен одному из заданных значений.
(Определяется CardExtensionContextExtensions)
CardTypeIs Возвращает признак того, что имя типа карточки (свойство CardTypeName) равно одному из заданных значений. Пользуясь данным методом необходимо учитывать, что поле CardType может быть равным null.
(Определяется CardExtensionContextExtensions)
CardTypeIs Возвращает признак того, что идентификатор типа карточки равен одному из заданных значений.
(Определяется CardExtensionContextExtensions)
CardTypeIs Возвращает признак того, что имя типа карточки (свойство CardTypeName) равно одному из заданных значений. Пользуясь данным методом необходимо учитывать, что поле CardType может быть равным null.
(Определяется CardExtensionContextExtensions)
CardTypeIs Возвращает признак того, что идентификатор типа карточки равен одному из заданных значений.
(Определяется CardExtensionContextExtensions)
CardTypeIs Возвращает признак того, что имя типа карточки (свойство CardTypeName) равно одному из заданных значений. Пользуясь данным методом необходимо учитывать, что поле CardType может быть равным null.
(Определяется CardExtensionContextExtensions)
ClearCardIDListToLoadSignatures Очищает список идентификаторов карточек, для которых будут загружены подписи для файлов. Возвращает признак того, что список присутствовал перед вызовом метода.
(Определяется CardRequestExtensions)
CreateMetadataBinder Создаёт объект ICardMetadataBinder для удаления строк из коллекционных секций для указанной карточки.
(Определяется CardExtensions)
SetActionHistoryRowID Устанавливает идентификатор записи в историю действий, которая была записана в процессе обработки запроса, или null, если требуется удалить предыдущий идентификатор.
(Определяется CardRequestExtensions)
SetCardAccessAsync Устанавливает доступ на редактирование полей указанной секции карточки в серверный токен безопасности, который хранится в дополнительной информации контекста расширений карточки.
(Определяется KrPermissionExtensions)
SetCardAccessAsync Устанавливает доступ на редактирование полей указанной секции карточки в серверный токен безопасности, который хранится в дополнительной информации контекста расширений карточки.
(Определяется KrPermissionExtensions)
SetContextData Устанавливает данные в контексте цепочки расширений для заданного объекта-отправителя sender. Данные существует в пределах цепочки расширений.
(Определяется CardRequestExtensions)
TryGetActionHistoryRowID Возвращает идентификатор записи в историю действий, которая была записана в процессе обработки запроса, или null, если записи в истории действий не было сделано.
(Определяется CardRequestExtensions)
TryGetCardIDListToLoadSignatures Возвращает список идентификаторов карточек, для которых будут загружены подписи для файлов, помимо текущей загруженной карточки, или null, если список не был создан или был очищен.
(Определяется CardRequestExtensions)
TryGetContextDataT Возвращает данные, записанные методом SetContextData(ICardExtensionContext, Object, Object) в контекст цепочки расширений для заданного объекта-отправителя sender. Данные существует в пределах цепочки расширений. Возвращает null, если данные не найдены или были установлены как null.
(Определяется CardRequestExtensions)

См. также