Show / Hide Table of Contents

Class ClientProxyBase<TService>

Inheritance
object
ClientProxyBase<TService>
AbpTenantClientProxy
AbpApplicationConfigurationClientProxy
AbpApplicationLocalizationClientProxy
DynamicHttpProxyInterceptorClientProxy<TService>
Implements
ITransientDependency
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Volo.Abp.Http.Client.ClientProxying
Assembly: Volo.Abp.Http.Client.dll
Syntax
public class ClientProxyBase<TService> : ITransientDependency
Type Parameters
Name Description
TService

Constructors

ClientProxyBase()

Declaration
public ClientProxyBase()

Properties

AbpCorrelationIdOptions

Declaration
protected IOptions<AbpCorrelationIdOptions> AbpCorrelationIdOptions { get; }
Property Value
Type Description
Microsoft.Extensions.Options.IOptions<TOptions><AbpCorrelationIdOptions>

CancellationTokenProvider

Declaration
protected ICancellationTokenProvider CancellationTokenProvider { get; }
Property Value
Type Description
ICancellationTokenProvider

ClientAuthenticator

Declaration
protected IRemoteServiceHttpClientAuthenticator ClientAuthenticator { get; }
Property Value
Type Description
IRemoteServiceHttpClientAuthenticator

ClientOptions

Declaration
protected IOptions<AbpHttpClientOptions> ClientOptions { get; }
Property Value
Type Description
Microsoft.Extensions.Options.IOptions<TOptions><AbpHttpClientOptions>

ClientProxyApiDescriptionFinder

Declaration
protected IClientProxyApiDescriptionFinder ClientProxyApiDescriptionFinder { get; }
Property Value
Type Description
IClientProxyApiDescriptionFinder

ClientProxyRequestPayloadBuilder

Declaration
protected ClientProxyRequestPayloadBuilder ClientProxyRequestPayloadBuilder { get; }
Property Value
Type Description
ClientProxyRequestPayloadBuilder

ClientProxyUrlBuilder

Declaration
protected ClientProxyUrlBuilder ClientProxyUrlBuilder { get; }
Property Value
Type Description
ClientProxyUrlBuilder

CorrelationIdProvider

Declaration
protected ICorrelationIdProvider CorrelationIdProvider { get; }
Property Value
Type Description
ICorrelationIdProvider

CurrentApiVersionInfo

Declaration
protected ICurrentApiVersionInfo CurrentApiVersionInfo { get; }
Property Value
Type Description
ICurrentApiVersionInfo

CurrentTenant

Declaration
protected ICurrentTenant CurrentTenant { get; }
Property Value
Type Description
ICurrentTenant

HttpClientFactory

Declaration
protected IProxyHttpClientFactory HttpClientFactory { get; }
Property Value
Type Description
IProxyHttpClientFactory

JsonSerializer

Declaration
protected IJsonSerializer JsonSerializer { get; }
Property Value
Type Description
IJsonSerializer

LazyServiceProvider

Declaration
public IAbpLazyServiceProvider LazyServiceProvider { get; set; }
Property Value
Type Description
IAbpLazyServiceProvider

RemoteServiceConfigurationProvider

Declaration
protected IRemoteServiceConfigurationProvider RemoteServiceConfigurationProvider { get; }
Property Value
Type Description
IRemoteServiceConfigurationProvider

Methods

AddHeaders(IReadOnlyDictionary<string, object>, ActionApiDescriptionModel, HttpRequestMessage, ApiVersionInfo)

Declaration
protected virtual void AddHeaders(IReadOnlyDictionary<string, object> argumentsDictionary, ActionApiDescriptionModel action, HttpRequestMessage requestMessage, ApiVersionInfo apiVersion)
Parameters
Type Name Description
System.Collections.Generic.IReadOnlyDictionary<TKey, TValue><string, object> argumentsDictionary
ActionApiDescriptionModel action
System.Net.Http.HttpRequestMessage requestMessage
ApiVersionInfo apiVersion

BuildHttpProxyClientProxyContext(string, ClientProxyRequestTypeValue)

Declaration
protected virtual ClientProxyRequestContext BuildHttpProxyClientProxyContext(string methodName, ClientProxyRequestTypeValue arguments = null)
Parameters
Type Name Description
string methodName
ClientProxyRequestTypeValue arguments
Returns
Type Description
ClientProxyRequestContext

FindBestApiVersionAsync(ClientProxyRequestContext)

Declaration
protected virtual Task<string> FindBestApiVersionAsync(ClientProxyRequestContext requestContext)
Parameters
Type Name Description
ClientProxyRequestContext requestContext
Returns
Type Description
System.Threading.Tasks.Task<TResult><string>

GetApiVersionInfoAsync(ClientProxyRequestContext)

Declaration
protected virtual Task<ApiVersionInfo> GetApiVersionInfoAsync(ClientProxyRequestContext requestContext)
Parameters
Type Name Description
ClientProxyRequestContext requestContext
Returns
Type Description
System.Threading.Tasks.Task<TResult><ApiVersionInfo>

GetCancellationToken(IReadOnlyDictionary<string, object>)

Declaration
protected virtual CancellationToken GetCancellationToken(IReadOnlyDictionary<string, object> arguments)
Parameters
Type Name Description
System.Collections.Generic.IReadOnlyDictionary<TKey, TValue><string, object> arguments
Returns
Type Description
System.Threading.CancellationToken

GetConfiguredApiVersionAsync(ClientProxyRequestContext)

Declaration
protected virtual Task<string> GetConfiguredApiVersionAsync(ClientProxyRequestContext requestContext)
Parameters
Type Name Description
ClientProxyRequestContext requestContext
Returns
Type Description
System.Threading.Tasks.Task<TResult><string>

GetHttpContentAsync(ClientProxyRequestContext, ApiVersionInfo)

Declaration
protected virtual Task<HttpContent> GetHttpContentAsync(ClientProxyRequestContext requestContext, ApiVersionInfo apiVersion)
Parameters
Type Name Description
ClientProxyRequestContext requestContext
ApiVersionInfo apiVersion
Returns
Type Description
System.Threading.Tasks.Task<TResult><HttpContent>

GetUrlWithParametersAsync(ClientProxyRequestContext, ApiVersionInfo)

Declaration
protected virtual Task<string> GetUrlWithParametersAsync(ClientProxyRequestContext requestContext, ApiVersionInfo apiVersion)
Parameters
Type Name Description
ClientProxyRequestContext requestContext
ApiVersionInfo apiVersion
Returns
Type Description
System.Threading.Tasks.Task<TResult><string>

RemoveQuotes(StringSegment)

Declaration
protected virtual StringSegment RemoveQuotes(StringSegment input)
Parameters
Type Name Description
Microsoft.Extensions.Primitives.StringSegment input
Returns
Type Description
Microsoft.Extensions.Primitives.StringSegment

RequestAsync(string, ClientProxyRequestTypeValue)

Declaration
protected virtual Task RequestAsync(string methodName, ClientProxyRequestTypeValue arguments = null)
Parameters
Type Name Description
string methodName
ClientProxyRequestTypeValue arguments
Returns
Type Description
System.Threading.Tasks.Task

RequestAsync(ClientProxyRequestContext)

Declaration
protected virtual Task<HttpContent> RequestAsync(ClientProxyRequestContext requestContext)
Parameters
Type Name Description
ClientProxyRequestContext requestContext
Returns
Type Description
System.Threading.Tasks.Task<TResult><HttpContent>

RequestAsync<T>(string, ClientProxyRequestTypeValue)

Declaration
protected virtual Task<T> RequestAsync<T>(string methodName, ClientProxyRequestTypeValue arguments = null)
Parameters
Type Name Description
string methodName
ClientProxyRequestTypeValue arguments
Returns
Type Description
System.Threading.Tasks.Task<TResult><T>
Type Parameters
Name Description
T

RequestAsync<T>(ClientProxyRequestContext)

Declaration
protected virtual Task<T> RequestAsync<T>(ClientProxyRequestContext requestContext)
Parameters
Type Name Description
ClientProxyRequestContext requestContext
Returns
Type Description
System.Threading.Tasks.Task<TResult><T>
Type Parameters
Name Description
T

ThrowExceptionForResponseAsync(HttpResponseMessage)

Declaration
protected virtual Task ThrowExceptionForResponseAsync(HttpResponseMessage response)
Parameters
Type Name Description
System.Net.Http.HttpResponseMessage response
Returns
Type Description
System.Threading.Tasks.Task

Implements

ITransientDependency

Extension Methods

AbpObjectExtensions.As<T>(object)
AbpObjectExtensions.To<T>(object)
LockExtensions.Locking(object, Action)
LockExtensions.Locking<TResult>(object, Func<TResult>)
AbpObjectExtensions.If<T>(T, bool, Action<T>)
AbpObjectExtensions.If<T>(T, bool, Func<T, T>)
AbpObjectExtensions.IsIn<T>(T, IEnumerable<T>)
AbpObjectExtensions.IsIn<T>(T, params T[])
AbpQueryableExtensions.OrderByIf<T, TQueryable>(TQueryable, bool, string)
AbpQueryableExtensions.PageBy<T, TQueryable>(TQueryable, int, int)
AbpQueryableExtensions.WhereIf<T, TQueryable>(TQueryable, bool, Expression<Func<T, bool>>)
AbpQueryableExtensions.WhereIf<T, TQueryable>(TQueryable, bool, Expression<Func<T, int, bool>>)
LockExtensions.Locking<T>(T, Action<T>)
LockExtensions.Locking<T, TResult>(T, Func<T, TResult>)
In This Article
Back to top Powered by Volosoft