Show / Hide Table of Contents

Class ClientProxyBase<TService>

Inheritance
object
ClientProxyBase<TService>
AbpTenantClientProxy
AccountClientProxy
AccountExternalLoginClientProxy
AccountExternalProviderClientProxy
AccountSessionClientProxy
AccountSettingsClientProxy
DynamicClaimsClientProxy
IdentityLinkUserClientProxy
IdentityUserDelegationClientProxy
ProfileClientProxy
AbpApplicationConfigurationClientProxy
AbpApplicationLocalizationClientProxy
AuditLogSettingsClientProxy
AuditLogsClientProxy
FeaturesClientProxy
DynamicHttpProxyInterceptorClientProxy<TService>
IdentityClaimTypeClientProxy
IdentityExternalLoginClientProxy
IdentityRoleClientProxy
IdentitySecurityLogClientProxy
IdentitySessionClientProxy
IdentitySettingsClientProxy
IdentityUserClientProxy
IdentityUserLookupClientProxy
IdentityUserIntegrationClientProxy
OrganizationUnitClientProxy
ApiResourcesClientProxy
ApiScopesClientProxy
ClientsClientProxy
IdentityResourcesClientProxy
IdentityServerClaimTypesClientProxy
LanguageClientProxy
LanguageTextClientProxy
LeptonThemeSettingsClientProxy
ApplicationClientProxy
ScopeClientProxy
PermissionIntegrationClientProxy
PermissionsClientProxy
EmailSettingsClientProxy
TimeZoneSettingsClientProxy
TenantClientProxy
TemplateContentClientProxy
TemplateDefinitionClientProxy
BlogAdminClientProxy
BlogFeatureAdminClientProxy
BlogPostAdminClientProxy
CommentAdminClientProxy
ContactSettingClientProxy
FaqQuestionAdminClientProxy
FaqSectionAdminClientProxy
GlobalResourceAdminClientProxy
MediaDescriptorAdminClientProxy
MenuItemAdminClientProxy
NewsletterRecordAdminClientProxy
PageFeedbackAdminClientProxy
PageFeedbackSettingsClientProxy
PageAdminClientProxy
PollAdminClientProxy
EntityTagAdminClientProxy
TagAdminClientProxy
UrlShortingAdminClientProxy
BlogFeatureClientProxy
MediaDescriptorClientProxy
BlogPostPublicClientProxy
CommentPublicClientProxy
ContactPublicClientProxy
FaqSectionPublicClientProxy
GlobalResourcePublicClientProxy
MarkedItemPublicClientProxy
MenuItemPublicClientProxy
NewsletterRecordPublicClientProxy
PageFeedbackPublicClientProxy
PagesPublicClientProxy
PollPublicClientProxy
RatingPublicClientProxy
ReactionPublicClientProxy
TagPublicClientProxy
UrlShortingPublicClientProxy
DocumentsAdminClientProxy
ProjectsAdminClientProxy
DocsDocumentClientProxy
DocsProjectClientProxy
FormClientProxy
QuestionClientProxy
ResponseClientProxy
EditionClientProxy
SubscriptionClientProxy
TenantClientProxy
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
IOptions<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
IOptions<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

LocalEventBus

Declaration
protected ILocalEventBus LocalEventBus { get; }
Property Value
Type Description
ILocalEventBus

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
IReadOnlyDictionary<string, object> argumentsDictionary
ActionApiDescriptionModel action
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
Task<string>

GetApiVersionInfoAsync(ClientProxyRequestContext)

Declaration
protected virtual Task<ApiVersionInfo> GetApiVersionInfoAsync(ClientProxyRequestContext requestContext)
Parameters
Type Name Description
ClientProxyRequestContext requestContext
Returns
Type Description
Task<ApiVersionInfo>

GetCancellationToken(IReadOnlyDictionary<string, object>)

Declaration
protected virtual CancellationToken GetCancellationToken(IReadOnlyDictionary<string, object> arguments)
Parameters
Type Name Description
IReadOnlyDictionary<string, object> arguments
Returns
Type Description
CancellationToken

GetConfiguredApiVersionAsync(ClientProxyRequestContext)

Declaration
protected virtual Task<string?> GetConfiguredApiVersionAsync(ClientProxyRequestContext requestContext)
Parameters
Type Name Description
ClientProxyRequestContext requestContext
Returns
Type Description
Task<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
Task<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
Task<string>

RemoveQuotes(StringSegment)

Declaration
protected virtual StringSegment RemoveQuotes(StringSegment input)
Parameters
Type Name Description
StringSegment input
Returns
Type Description
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
Task

RequestAsync(ClientProxyRequestContext)

Declaration
protected virtual Task<HttpContent> RequestAsync(ClientProxyRequestContext requestContext)
Parameters
Type Name Description
ClientProxyRequestContext requestContext
Returns
Type Description
Task<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
Task<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
Task<T>
Type Parameters
Name Description
T

ThrowExceptionForResponseAsync(HttpResponseMessage)

Declaration
protected virtual Task ThrowExceptionForResponseAsync(HttpResponseMessage response)
Parameters
Type Name Description
HttpResponseMessage response
Returns
Type Description
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>>)
AbpOpenIddictQueryableExtensions.SkipIf<T, TQueryable>(TQueryable, bool, int?)
AbpOpenIddictQueryableExtensions.TakeIf<T, TQueryable>(TQueryable, bool, int?)
LockExtensions.Locking<T>(T, Action<T>)
LockExtensions.Locking<T, TResult>(T, Func<T, TResult>)
In this article
Back to top Powered by ABP.IO Platform