public abstract class BaseClientService : object, IClientService, IDisposable
A base class for a client service which provides common mechanism for all services, like
serialization and GZip support. It should be safe to use a single service instance to make server requests
concurrently from multiple threads.
This class adds a special IHttpExecuteInterceptor to the
ConfigurableMessageHandler execute interceptor list, which uses the given
Authenticator. It calls to its applying authentication method, and injects the "Authorization" header in the
request.
If the given Authenticator implements IHttpUnsuccessfulResponseHandler, this
class adds the Authenticator to the ConfigurableMessageHandler's unsuccessful
response handler list.
Inheritance
Object >
BaseClientService
Namespace
Google.Apis.Services
Assembly
Google.Apis.dll
Constructors
BaseClientService(BaseClientService.Initializer)
protected BaseClientService(BaseClientService.Initializer initializer)
Constructs a new base client with the specified initializer.
Fields
DefaultMaxUrlLength
public const uint DefaultMaxUrlLength = null
The default maximum allowed length of a URL string for GET requests.
Properties
ApiKey
public string ApiKey { get; }
Gets the API-Key (DeveloperKey) which this service uses for all requests.
ApplicationName
public string ApplicationName { get; }
Gets the application name to be used in the User-Agent header.
BasePath
public abstract string BasePath { get; }
Gets the BasePath of the service.
BaseUri
public abstract string BaseUri { get; }
Gets the BaseUri of the service. All request paths should be relative to this URI.
BaseUriOverride
protected string BaseUriOverride { get; }
The BaseUri provided in the initializer, which may be null.
BatchPath
public virtual string BatchPath { get; }
The path used for batch operations.
BatchUri
public virtual string BatchUri { get; }
The URI used for batch operations.
Features
public abstract IList<string> Features { get; }
Gets the supported features by this service.
GZipEnabled
public bool GZipEnabled { get; }
Gets or sets whether this service supports GZip.
HttpClient
public ConfigurableHttpClient HttpClient { get; }
Gets the HTTP client which is used to create requests.
HttpClientInitializer
public IConfigurableHttpClientInitializer HttpClientInitializer { get; }
Property Value
Name
public abstract string Name { get; }
Property Value
Serializer
public ISerializer Serializer { get; }
Gets the Serializer used by this service.
Methods
CreateBackOffHandler()
protected virtual BackOffHandler CreateBackOffHandler()
Creates the back-off handler with ExponentialBackOff.
Overrides this method to change the default behavior of back-off handler (e.g. you can change the maximum
waited request's time span, or create a back-off handler with you own implementation of
IBackOff).
DeserializeError(HttpResponseMessage)
public virtual Task<RequestError> DeserializeError(HttpResponseMessage response)
Parameter
| Type | Name | Description |
|---|
| HttpResponseMessage | response | |
Returns
Exceptions
DeserializeResponse<T>(HttpResponseMessage)
public virtual Task<T> DeserializeResponse<T>(HttpResponseMessage response)
Deserializes a response into the specified object.
| Type | Name | Description |
|---|
| HttpResponseMessage | response | |
Returns
Type Parameter
Dispose()
public virtual void Dispose()
SerializeObject(Object)
public virtual string SerializeObject(object obj)
Serializes an object into a string representation.
SetRequestSerailizedContent(HttpRequestMessage, Object)
public void SetRequestSerailizedContent(HttpRequestMessage request, object body)
Sets the content of the request by the given body and the this service's configuration.
First the body object is serialized by the Serializer and then, if GZip is enabled, the content will be
wrapped in a GZip stream, otherwise a regular string stream will be used.
| Type | Name | Description |
|---|
| HttpRequestMessage | request | |
| Object | body | |
Implements
IDisposable
Extension Method
