ICardRequestExtensionContext - интерфейс

Контекст универсального взаимодействия с сервисом карточек.

Definition

Пространство имён: Tessa.Cards.Extensions
Сборка: Tessa (в Tessa.dll) Версия: 4.0.4
C#
public interface ICardRequestExtensionContext : ICardRequestExtensionContext<CardRequest, CardResponse>, 
	ICardExtensionContext, ICardTypeExtensionContext, ITraceableInfoExtensionContext, ITraceableExtensionContext, IExtensionContext
Implements
ICardExtensionContext, ICardRequestExtensionContextCardRequest, CardResponse, 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)
FileType Тип файла или null, если тип файла неизвестен.
FileTypeName Имя типа файла или null, если имя типа неизвестно. Имя может быть задано для несуществующего типа файла.
Info Дополнительная информация, связанная с контекстом расширений.
(Унаследован от ITraceableInfoExtensionContext)
RequestЗапрос на взаимодействие с карточкой.
(Унаследован от ICardRequestExtensionContextTRequest, TResponse)
RequestIsSuccessful Признак того, что процесс взаимодействия с карточкой завершился успешно. Можно использовать в расширениях, выполняющихся после запроса к сервису.
(Унаследован от ICardExtensionContext)
RequestType Идентификатор типа универсального запроса к сервису карточек. Соответствует конкретной операции, которую требуется выполнить.
Response Ответ на запрос по взаимодействию с карточкой. Если свойство установлено перед выполнением взаимодействия с карточкой стандартными средствами, то такое взаимодействие не производится.
(Унаследован от ICardRequestExtensionContextTRequest, TResponse)
SessionСессия пользователя, для которого выполняется процесс взаимодействия с карточкой.
(Унаследован от ICardExtensionContext)
TaskType Тип задания или null, если тип задания неизвестен.
TaskTypeName Имя типа задания или null, если имя типа неизвестно. Имя может быть задано для несуществующего типа задания.
ValidationResult Объект, выполняющий построение результата валидации. Может использоваться для того, чтобы запретить выполнение процесса стандартными средствами.
(Унаследован от ITraceableExtensionContext)

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

AddInvalidateCompletedCacheNames Добавляет имена фактически сброшенных кэшей в контексте запроса InvalidateCache. Значение null и пустой список идентичны. Пустой список означает, что сброс кэшей не выполняется.
(Определяется CardRequestExtensions)
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)
ClearInvalidateCompletedCacheNames Очищает имена фактически сброшенных кэшей в контексте запроса InvalidateCache.
(Определяется CardRequestExtensions)
CreateMetadataBinder Создаёт объект ICardMetadataBinder для удаления строк из коллекционных секций для указанной карточки.
(Определяется CardExtensions)
IsInvalidatingAllCaches Возвращает признак того, что запрошен сброс всех кэшей в контексте запроса InvalidateCache.
(Определяется CardRequestExtensions)
RemoveInvalidateCompletedCacheNames Удаляет имена фактически сброшенных кэшей в контексте запроса InvalidateCache. Значение null и пустой список идентичны. Пустой список означает, что сброс кэшей не выполняется.
(Определяется CardRequestExtensions)
SetActionHistoryRowID Устанавливает идентификатор записи в историю действий, которая была записана в процессе обработки запроса, или null, если требуется удалить предыдущий идентификатор.
(Определяется CardRequestExtensions)
SetCardAccessAsync Устанавливает доступ на редактирование полей указанной секции карточки в серверный токен безопасности, который хранится в дополнительной информации контекста расширений карточки.
(Определяется KrPermissionExtensions)
SetCardAccessAsync Устанавливает доступ на редактирование полей указанной секции карточки в серверный токен безопасности, который хранится в дополнительной информации контекста расширений карточки.
(Определяется KrPermissionExtensions)
SetContextData Устанавливает данные в контексте цепочки расширений для заданного объекта-отправителя sender. Данные существует в пределах цепочки расширений.
(Определяется CardRequestExtensions)
SetInvalidateCacheNames Устанавливает имена сбрасываемых кэшей в контексте запроса InvalidateCache. Значение null определяет, что выполняется сброс всех кэшей. Пустой список означает, что сброс кэшей не выполняется.
(Определяется CardRequestExtensions)
ShouldInvalidateCache Проверяет необходимость сброса кэша в контексте запроса InvalidateCache. Возвращает true, если был запрошен сброс указанного кэша или всех кэшей.
(Определяется CardRequestExtensions)
TryGetActionHistoryRowID Возвращает идентификатор записи в историю действий, которая была записана в процессе обработки запроса, или null, если записи в истории действий не было сделано.
(Определяется CardRequestExtensions)
TryGetContextDataT Возвращает данные, записанные методом SetContextData(ICardExtensionContext, Object, Object) в контекст цепочки расширений для заданного объекта-отправителя sender. Данные существует в пределах цепочки расширений. Возвращает null, если данные не найдены или были установлены как null.
(Определяется CardRequestExtensions)
TryGetInvalidateCacheNames Возвращает имена сбрасываемых кэшей в контексте запроса InvalidateCache или null, если имена не заданы, в этом случае инвалидация выполняется для всех кэшей.
(Определяется CardRequestExtensions)
TryGetInvalidateCompletedCacheNames Возвращает имена сбрасываемых кэшей в контексте запроса InvalidateCache или null, если имена не заданы, в этом случае инвалидация выполняется для всех кэшей.
(Определяется CardRequestExtensions)

См. также