C# Class Google.Apis.Requests.Request

Request to a service.

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

Inheritance: IRequest

Show file Open project: artzub/LoggenCSG

Public Properties

Property	Type	Description
ContentCharset	System.Text.Encoding
SupportedHttpMethods	ReadOnlyCollection

Private Properties

Property	Type	Description
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

Public Methods

Method	Description
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.

Private Methods

Method	Description
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.

Method Details

CreateRequest() public static method

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

public static CreateRequest ( IService service, IMethod method ) : IRequest
service	IService
method	IMethod
return	IRequest

ExecuteRequest() public method

Executes a request given the configuration options supplied.

public ExecuteRequest ( ) : IResponse
return	IResponse

ExecuteRequestAsync() public method

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.
return	void

HttpMethodHasBody() public static method

Returns true if this http method can have a body.

public static HttpMethodHasBody ( string httpMethod ) : bool
httpMethod	string
return	bool

On() public method

The method to call

public On ( string rpcName ) : IRequest
rpcName	string
return	IRequest

Request() public method

public Request ( ) : System.IO.Compression
return	System.IO.Compression

Returning() public method

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 ///
return	IRequest

ToString() public method

public ToString ( ) : string
return	string

WithAppName() public method

Sets the Application name on the UserAgent String.

public WithAppName ( string name ) : IRequest
name	string	/// A ///
return	IRequest

WithAuthentication() public method

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

public WithAuthentication ( IAuthenticator authenticator ) : IRequest
authenticator	IAuthenticator
return	IRequest

WithBody() public method

Uses the string provied as the body of the request.

public WithBody ( string body ) : IRequest
body	string
return	IRequest

WithETag() public method

Adds an ETag to this request.

public WithETag ( string etag ) : IRequest
etag	string
return	IRequest

WithETagAction() public method

Sets the ETag-behavior of this request.

public WithETagAction ( ETagAction action ) : IRequest
action	ETagAction
return	IRequest

WithFields() public method

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.
return	IRequest

WithKey() public method

Adds the developer key to this request.

public WithKey ( string key ) : IRequest
key	string
return	IRequest

WithParameters() public method

Adds the parameters to the request.

public WithParameters ( object>.IDictionary parameters ) : IRequest
parameters	object>.IDictionary
return	IRequest

WithParameters() public method

Adds the parameters to the request.

public WithParameters ( string>.IEnumerable parameters ) : IRequest
parameters	string>.IEnumerable
return	IRequest

WithParameters() public method

Parses the specified querystring and adds these parameters to the request

public WithParameters ( string parameters ) : IRequest
parameters	string
return	IRequest

WithUserIp() public method

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
return	IRequest

Property Details

ContentCharset public static property

The charset used for content encoding.

public static Encoding,System.Text ContentCharset
return	System.Text.Encoding

SupportedHttpMethods public static property

public static ReadOnlyCollection SupportedHttpMethods
return	ReadOnlyCollection