C# Класс Google.Apis.Requests.Request

Request to a service.

Features which are not (yet) supported on SilverLight: - The UserAgent header. - GZip Compression

Наследование: IRequest

Открытые свойства

Свойство	Тип	Описание
ContentCharset	System.Text.Encoding
SupportedHttpMethods	ReadOnlyCollection

Private Properties

Свойство	Тип	Описание
AttachBody	void
BuildRequest	System.Net.HttpWebRequest
CreateWebRequest	System.Net.WebRequest
EndAttachBody	void
FormatForUserAgent	string
GetDefaultETagAction	ETagAction
GetErrorResponseHandlers	IEnumerable
GetReturnMimeType	string
HandleFailedRequest	bool
InternalBeginExecuteRequest	void
InternalEndExecuteRequest	void

Открытые методы

Метод	Описание
CreateRequest ( IService service, IMethod method ) : IRequest	Given an API method, create the appropriate Request for it.
ExecuteRequest ( ) : IResponse	Executes a request given the configuration options supplied.
ExecuteRequestAsync ( Action responseHandler ) : void	Executes the request asynchronously, and calls the specified delegate once done.
HttpMethodHasBody ( string httpMethod ) : bool	Returns true if this http method can have a body.
On ( string rpcName ) : IRequest	The method to call
Request ( ) : System.IO.Compression
Returning ( ReturnType returnType ) : IRequest	Sets the type of data that is expected to be returned from the request. Defaults to Json.
ToString ( ) : string
WithAppName ( string name ) : IRequest	Sets the Application name on the UserAgent String.
WithAuthentication ( IAuthenticator authenticator ) : IRequest	Uses the provided authenticator to add authentication information to this request.
WithBody ( string body ) : IRequest	Uses the string provied as the body of the request.
WithETag ( string etag ) : IRequest	Adds an ETag to this request.
WithETagAction ( ETagAction action ) : IRequest	Sets the ETag-behavior of this request.
WithFields ( string mask ) : IRequest	Specifies the partial field mask of this method. The response of this request will only contain the fields specified in this mask.
WithKey ( string key ) : IRequest	Adds the developer key to this request.
WithParameters ( object>.IDictionary parameters ) : IRequest	Adds the parameters to the request.
WithParameters ( string>.IEnumerable parameters ) : IRequest	Adds the parameters to the request.
WithParameters ( string parameters ) : IRequest	Parses the specified querystring and adds these parameters to the request
WithUserIp ( string userIp ) : IRequest	IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Приватные методы

Метод	Описание
AttachBody ( WebRequest request, Action onRequestReady ) : void
BuildRequest ( ) : HttpWebRequest
CreateWebRequest ( Action onRequestReady ) : WebRequest
EndAttachBody ( IAsyncResult asyncResult ) : void	Complete the attach-body portion of the request and continue executing the call.
FormatForUserAgent ( string fragment ) : string
GetDefaultETagAction ( string httpVerb ) : ETagAction
GetErrorResponseHandlers ( ) : IEnumerable
GetReturnMimeType ( ReturnType returnType ) : string
HandleFailedRequest ( AsyncExecutionState state, WebException exception, AsyncRequestResult &asyncRequestResult ) : bool	Handles a failed request, and tries to fix it if possible. Can not throw an exception.
InternalBeginExecuteRequest ( AsyncExecutionState state ) : void	Begins executing a request based upon the current execution state. Does not check preconditions.
InternalEndExecuteRequest ( IAsyncResult asyncResult ) : void	Ends executing an asynchronous request.

Описание методов

CreateRequest() публичный статический Метод

Given an API method, create the appropriate Request for it.

public static CreateRequest ( IService service, IMethod method ) : IRequest
service	IService
method	IMethod
Результат	IRequest

ExecuteRequest() публичный Метод

Executes a request given the configuration options supplied.

public ExecuteRequest ( ) : IResponse
Результат	IResponse

ExecuteRequestAsync() публичный Метод

Executes the request asynchronously, and calls the specified delegate once done.

public ExecuteRequestAsync ( Action responseHandler ) : void
responseHandler	Action	The method to call once a response has been received.
Результат	void

HttpMethodHasBody() публичный статический Метод

Returns true if this http method can have a body.

public static HttpMethodHasBody ( string httpMethod ) : bool
httpMethod	string
Результат	bool

On() публичный Метод

The method to call

public On ( string rpcName ) : IRequest
rpcName	string
Результат	IRequest

Request() публичный Метод

public Request ( ) : System.IO.Compression
Результат	System.IO.Compression

Returning() публичный Метод

Sets the type of data that is expected to be returned from the request. Defaults to Json.

public Returning ( ReturnType returnType ) : IRequest
returnType	ReturnType	/// A ///
Результат	IRequest

ToString() публичный Метод

public ToString ( ) : string
Результат	string

WithAppName() публичный Метод

Sets the Application name on the UserAgent String.

public WithAppName ( string name ) : IRequest
name	string	/// A ///
Результат	IRequest

WithAuthentication() публичный Метод

Uses the provided authenticator to add authentication information to this request.

public WithAuthentication ( IAuthenticator authenticator ) : IRequest
authenticator	IAuthenticator
Результат	IRequest

WithBody() публичный Метод

Uses the string provied as the body of the request.

public WithBody ( string body ) : IRequest
body	string
Результат	IRequest

WithETag() публичный Метод

Adds an ETag to this request.

public WithETag ( string etag ) : IRequest
etag	string
Результат	IRequest

WithETagAction() публичный Метод

Sets the ETag-behavior of this request.

public WithETagAction ( ETagAction action ) : IRequest
action	ETagAction
Результат	IRequest

WithFields() публичный Метод

Specifies the partial field mask of this method. The response of this request will only contain the fields specified in this mask.

public WithFields ( string mask ) : IRequest
mask	string	Selector specifying which fields to include in a partial response.
Результат	IRequest

WithKey() публичный Метод

Adds the developer key to this request.

public WithKey ( string key ) : IRequest
key	string
Результат	IRequest

WithParameters() публичный Метод

Adds the parameters to the request.

public WithParameters ( object>.IDictionary parameters ) : IRequest
parameters	object>.IDictionary
Результат	IRequest

WithParameters() публичный Метод

Adds the parameters to the request.

public WithParameters ( string>.IEnumerable parameters ) : IRequest
parameters	string>.IEnumerable
Результат	IRequest

WithParameters() публичный Метод

Parses the specified querystring and adds these parameters to the request

public WithParameters ( string parameters ) : IRequest
parameters	string
Результат	IRequest

WithUserIp() публичный Метод

IP address of the site where the request originates. Use this if you want to enforce per-user limits.

public WithUserIp ( string userIp ) : IRequest
userIp	string
Результат	IRequest

Описание свойств

ContentCharset публичное статическое свойство

The charset used for content encoding.

public static Encoding,System.Text ContentCharset
Результат	System.Text.Encoding

SupportedHttpMethods публичное статическое свойство

public static ReadOnlyCollection SupportedHttpMethods
Результат	ReadOnlyCollection