Interface IClientService (1.55.0)

public interface IClientService : IDisposable

Client service contains all the necessary information a Google service requires. Each concrete 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.

Inherited Members

IDisposable.Dispose()

Namespace

Google.Apis.Services

Assembly

Google.Apis.dll

Properties

ApiKey

string ApiKey { get; }

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

Property Value
Type	Description
`String`

ApplicationName

string ApplicationName { get; }

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

Property Value
Type	Description
`String`

BasePath

string BasePath { get; }

Gets the BasePath of the service.

Property Value
Type	Description
`String`

BaseUri

string BaseUri { get; }

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

Property Value
Type	Description
`String`

Features

IList<string> Features { get; }

Gets the supported features by this service.

Property Value
Type	Description
`IList<String>`

GZipEnabled

bool GZipEnabled { get; }

Gets or sets whether this service supports GZip.

Property Value
Type	Description
`Boolean`

HttpClient

ConfigurableHttpClient HttpClient { get; }

Gets the HTTP client which is used to create requests.

Property Value
Type	Description
`ConfigurableHttpClient`

HttpClientInitializer

IConfigurableHttpClientInitializer HttpClientInitializer { get; }

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

Property Value
Type	Description
`IConfigurableHttpClientInitializer`

Name

string Name { get; }

Gets the service name.

Property Value
Type	Description
`String`

Serializer

ISerializer Serializer { get; }

Gets the Serializer used by this service.

Property Value
Type	Description
`ISerializer`

Methods

DeserializeError(HttpResponseMessage)

Task<RequestError> DeserializeError(HttpResponseMessage response)

Deserializes an error response into a RequestError object.

Parameter
Name	Description
`response`	`HttpResponseMessage`

Returns
Type	Description
`Task<RequestError>`

Exceptions
Type	Description
`GoogleApiException`	If no error is found in the response.

DeserializeResponse<T>(HttpResponseMessage)

Task<T> DeserializeResponse<T>(HttpResponseMessage response)

Deserializes a response into the specified object.

Parameter
Name	Description
`response`	`HttpResponseMessage`

Returns
Type	Description
`Task<T>`

Type Parameter
Name	Description
`T`

SerializeObject(Object)

string SerializeObject(object data)

Serializes an object into a string representation.

Parameter
Name	Description
`data`	`Object`

Returns
Type	Description
`String`

SetRequestSerailizedContent(HttpRequestMessage, Object)

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.

Parameters
Name	Description
`request`	`HttpRequestMessage`
`body`	`Object`

Extension Method

Utilities.ThrowIfNull<T>(T, String)