Google API Client Library for .NET  1.10.0
Public Member Functions | Properties | List of all members
Google.Apis.Services.IClientService Interface Reference

Client service contains all the necessary information a Google service requires. Each concrete Google.Apis.Requests.IClientServiceRequest has a reference to a service for important properties like API key, application name, base Uri, etc. This service interface also contains serialization methods to serialize an object to stream and deserialize a stream into an object. More...

Inheritance diagram for Google.Apis.Services.IClientService:
Google.Apis.Services.BaseClientService

Public Member Functions

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. More...
 
string SerializeObject (object data)
 Serializes an object into a string representation. More...
 
Task< T > DeserializeResponse< T > (HttpResponseMessage response)
 Deserializes a response into the specified object. More...
 
Task< RequestErrorDeserializeError (HttpResponseMessage response)
 Deserializes an error response into a RequestError object. More...
 

Properties

ConfigurableHttpClient HttpClient [get]
 Gets the HTTP client which is used to create requests. More...
 
IConfigurableHttpClientInitializer HttpClientInitializer [get]
 Gets a HTTP client initializer which is able to custom properties on Google.Apis.Http.ConfigurableHttpClient and Google.Apis.Http.ConfigurableMessageHandler. More...
 
string Name [get]
 Gets the service name. More...
 
string BaseUri [get]
 Gets the BaseUri of the service. All request paths should be relative to this URI. More...
 
string BasePath [get]
 Gets the BasePath of the service. More...
 
IList< string > Features [get]
 Gets the supported features by this service. More...
 
bool GZipEnabled [get]
 Gets or sets whether this service supports GZip. More...
 
string ApiKey [get]
 Gets the API-Key (DeveloperKey) which this service uses for all requests. More...
 
string ApplicationName [get]
 Gets the application name to be used in the User-Agent header. More...
 
ISerializer Serializer [get]
 Gets the Serializer used by this service. More...
 

Detailed Description

Client service contains all the necessary information a Google service requires. Each concrete Google.Apis.Requests.IClientServiceRequest has a reference to a service for important properties like API key, application name, base Uri, etc. This service interface also contains serialization methods to serialize an object to stream and deserialize a stream into an object.

Member Function Documentation

Task<RequestError> Google.Apis.Services.IClientService.DeserializeError ( HttpResponseMessage  response)

Deserializes an error response into a RequestError object.

Exceptions
GoogleApiExceptionIf no error is found in the response.

Implemented in Google.Apis.Services.BaseClientService.

Task<T> Google.Apis.Services.IClientService.DeserializeResponse< T > ( HttpResponseMessage  response)

Deserializes a response into the specified object.

Implemented in Google.Apis.Services.BaseClientService.

string Google.Apis.Services.IClientService.SerializeObject ( object  data)

Serializes an object into a string representation.

Implemented in Google.Apis.Services.BaseClientService.

void Google.Apis.Services.IClientService.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.

Implemented in Google.Apis.Services.BaseClientService.

Property Documentation

string Google.Apis.Services.IClientService.ApiKey
get

Gets the API-Key (DeveloperKey) which this service uses for all requests.

string Google.Apis.Services.IClientService.ApplicationName
get

Gets the application name to be used in the User-Agent header.

string Google.Apis.Services.IClientService.BasePath
get

Gets the BasePath of the service.

string Google.Apis.Services.IClientService.BaseUri
get

Gets the BaseUri of the service. All request paths should be relative to this URI.

IList<string> Google.Apis.Services.IClientService.Features
get

Gets the supported features by this service.

bool Google.Apis.Services.IClientService.GZipEnabled
get

Gets or sets whether this service supports GZip.

ConfigurableHttpClient Google.Apis.Services.IClientService.HttpClient
get

Gets the HTTP client which is used to create requests.

IConfigurableHttpClientInitializer Google.Apis.Services.IClientService.HttpClientInitializer
get

Gets a HTTP client initializer which is able to custom properties on Google.Apis.Http.ConfigurableHttpClient and Google.Apis.Http.ConfigurableMessageHandler.

string Google.Apis.Services.IClientService.Name
get

Gets the service name.

ISerializer Google.Apis.Services.IClientService.Serializer
get

Gets the Serializer used by this service.


The documentation for this interface was generated from the following file: