OperationsWebProxy - класс

Прокси для обращения к веб-сервису операций. Методы аналогичны IOperationRepository.

Definition

Пространство имён: Tessa.Platform.Operations
Сборка: Tessa (в Tessa.dll) Версия: 3.6.0.22
C#
public sealed class OperationsWebProxy : WebProxy
Inheritance
Object    WebProxy    OperationsWebProxy

Конструкторы

OperationsWebProxyСоздаёт экземпляр класса с параметрами по умолчанию.

Свойства

BaseUri Базовый адрес папки веб-сервисов системы. Например: https://localhost/tessa. Должен быть установлен перед вызовом метода у прокси-объекта.
(Унаследован от WebProxy)
ControllerRoute Путь до контроллера на серверной стороне. Например: api/Cards.
(Унаследован от WebProxy)
HttpClient Объект, обеспечивающий соединение с веб-сервисом по протоколам HTTP/HTTPS. Должен быть установлен перед вызовом метода у прокси-объекта.
(Унаследован от WebProxy)
InstanceName Имя экземпляра сервера, с которым выполняется соединение. Например: default. Если установлены null или пустая строка, то используется имя экземпляра по умолчанию. Должен быть установлен перед вызовом метода у прокси-объекта.
(Унаследован от WebProxy)
IsDisposedПризнак того, что ресурсы объекта были освобождены.
(Унаследован от WebProxy)
IsSealedПризнак того, что объект был защищён от изменений.
(Унаследован от WebProxy)
ServiceName Имя веб-сервиса ASP.NET Core. Например: web.
(Унаследован от WebProxy)
SessionTokenHolder Объект, содержащий токен, связанный с текущей сессией, или null, если связь с сессией не поддерживается.
(Унаследован от WebProxy)
SessionVersionHolder Объект, содержащий версию платформы, связанную с текущей сессией, или null, если связь с сессией не поддерживается.
(Унаследован от WebProxy)
StreamingBufferSize Размер буфера в байтах, который используется для потоковой передачи. Обычно равен 1 Мб из константы DefaultStreamingBufferSize.
(Унаследован от WebProxy)

Методы

AddSessionToken Добавляет токен с текущей сессией к заголовкам сообщения, отправляемого на сервер, если объект SessionTokenHolder задан и содержит действительный токен сессии.
(Унаследован от WebProxy)
CheckSealed Выбрасывает исключение [Tessa.Platform.ObjectSealedException], если объект был защищён от изменений.
(Унаследован от WebProxy)
CompleteAsync Завершает операцию заданного типа, т.е. переводит её в состояние [Tessa.Platform.Operations.OperationState.Completed].
CreateAsyncСоздаёт операцию с заданными параметрами.
DeleteAsync Удаляет операцию с заданным идентификатором. Если операция не существовала, то не выдаётся сообщений об ошибках.
DeleteOlderThanAsyncВыполняет удаление записей, которые были созданы раньше заданных даты и времени.
DisposeОсвобождает ресурсы, занимаемые объектом.
(Унаследован от WebProxy)
DisposeAsyncОсвобождает ресурсы, занимаемые объектом.
(Унаследован от WebProxy)
DisposeAsync(Boolean)Освобождает ресурсы, занимаемые объектом.
(Унаследован от WebProxy)
EqualsDetermines whether the specified object is equal to the current object.
(Унаследован от Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Унаследован от Object)
GetAllAsyncВозвращает информацию по всем операциям. При запросе с клиента метод доступен только администраторам.
GetAllByTypeAsyncВозвращает информацию по всем операциям заданного типа. При запросе с клиента метод доступен только администраторам.
GetHashCodeServes as the default hash function.
(Унаследован от Object)
GetRequestUri Возвращает полный путь Uri к заданному методу для выполнения запроса к контроллеру.
(Унаследован от WebProxy)
GetStateAndProgressAsync Возвращает состояние и прогресс операции в процентах или null, если операция не найдена.
GetTypeGets the Type of the current instance.
(Унаследован от Object)
HasВозвращает признак того, что заданный флаг установлен.
(Унаследован от WebProxy)
HasAnyВозвращает признак того, что один из заданных флагов установлен.
(Унаследован от WebProxy)
HasNotВозвращает признак того, что заданный флаг не установлен.
(Унаследован от WebProxy)
IsAliveAsyncВозвращает признак того, что операция с заданным идентификатором существует.
MemberwiseCloneCreates a shallow copy of the current Object.
(Унаследован от Object)
OnDisposedAsync Действие, выполняемое при освобождении ресурсов, занимаемых объектом, в методе DisposeAsync(Boolean). В реализации по умолчанию вызывает событие Disposed.
(Унаследован от WebProxy)
ReportProgressAsync Сообщает о проценте готовности заданной операции, если операция находится в состоянии [Tessa.Platform.Operations.OperationState.InProgress]? и возвращает признак того, что изменение процента готовности удалось.
SealЗащищает объект от изменений.
(Унаследован от WebProxy)
SendAsyncTResponse Выполняет запрос заданного типа к веб-сервису с сериализуемыми параметрами и возвращает результат.
(Унаследован от WebProxy)
StartAsync Запускает операцию с заданным идентификатором. Операция должна быть создана и находиться в состоянии [Tessa.Platform.Operations.OperationState.Created].
StartFirstAsync Запускает из созданных операций заданного типа и возвращает идентификатор запущенной операции или null, если подходящая операция отсутствует.
ThrowOnErrorAsync Проверяет ответ от сервера на наличие ошибок. Если статусный код отличен от успешного, то выбрасывается исключение. Метод умеет обрабатывать значение ValidationResult, полученное от сервера и содержащее серверный стек-трейс, в этом случае выбрасывается ValidationException.
(Унаследован от WebProxy)
ToStringReturns a string that represents the current object.
(Унаследован от Object)
TryGetAsync Возвращает информацию по операции с заданным идентификатором или null, если операция отсутствует.
TryGetOperationIDByRequestHashAsync Возвращает идентификатор первой попавшейся операции по заданным идентификатору типа и хешу от запроса или null, если операция не найдена.

События

Disposed Событие, выполняемое при освобождении ресурсов, занимаемых объектом, в методе [System.IDisposable.Dispose].
(Унаследован от WebProxy)

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

Get
(Определяется ComHelper)
InternalMarkerCanvas Возвращает маркер аннотации
(Определяется AnnotationInternalsAccessor)
Invoke
(Определяется ComHelper)
Set
(Определяется ComHelper)

См. также