pp::URLResponseInfo Class Reference

URLResponseInfo provides an API for examining URL responses. More...

#include <url_response_info.h>

Inheritance diagram for pp::URLResponseInfo:

Collaboration diagram for pp::URLResponseInfo:

Public Member Functions
	URLResponseInfo ()
	URLResponseInfo (PassRef, PP_Resource resource)
	URLResponseInfo (const URLResponseInfo &other)
	The copy constructor for URLResponseInfo. More...
Var	GetProperty (PP_URLResponseProperty property) const
FileRef	GetBodyAsFileRef () const
Var	GetURL () const
Var	GetRedirectURL () const
Var	GetRedirectMethod () const
int32_t	GetStatusCode () const
Var	GetStatusLine () const
Var	GetHeaders () const
Public Member Functions inherited from pp::Resource
	Resource ()
	The default constructor. More...
	Resource (const Resource &other)
virtual	~Resource ()
	Destructor. More...
Resource &	operator= (const Resource &other)
bool	is_null () const
PP_Resource	pp_resource () const
PP_Resource	detach ()

Additional Inherited Members
Protected Member Functions inherited from pp::Resource
	Resource (PP_Resource resource)
	Resource (PassRef, PP_Resource resource)
void	PassRefFromConstructor (PP_Resource resource)
void	Clear ()
	Sets this resource to null. This releases ownership of the resource. More...

Detailed Description

URLResponseInfo provides an API for examining URL responses.

Definition at line 19 of file url_response_info.h.

Constructor & Destructor Documentation

pp::URLResponseInfo::URLResponseInfo ( )

inline

Default constructor. This constructor creates an is_null resource.

Definition at line 23 of file url_response_info.h.

pp::URLResponseInfo::URLResponseInfo	(	PassRef	,
		PP_Resource	resource
	)

A constructor used when you have received a PP_Resource as a return value that has already been reference counted.

Parameters

[in]

resource

A PP_Resource corresponding to a resource.

pp::URLResponseInfo::URLResponseInfo

(

const URLResponseInfo &

other

)

The copy constructor for URLResponseInfo.

Member Function Documentation

FileRef pp::URLResponseInfo::GetBodyAsFileRef

(

)

const

This function returns a FileRef pointing to the file containing the response body. This is only valid if PP_URLREQUESTPROPERTY_STREAMTOFILE was set on the URLRequestInfo used to produce this response. This file remains valid until the URLLoader associated with this URLResponseInfo is closed or destroyed.

Returns

A FileRef corresponding to a FileRef if successful, an is_null object if PP_URLREQUESTPROPERTY_STREAMTOFILE was not requested or if the URLLoader has not been opened yet.

Var pp::URLResponseInfo::GetHeaders ( ) const

inline

This function gets the PP_URLRESPONSEPROPERTY_HEADERS property for the response.

Returns

An is_string Var containing the response property value if successful, is_undefined Var if an input parameter is invalid.

Definition at line 113 of file url_response_info.h.

References GetProperty().

Var pp::URLResponseInfo::GetProperty

(

PP_URLResponseProperty

property

)

const

This function gets a response property.

Parameters

[in]

property

A PP_URLResponseProperty identifying the type of property in the response.

Returns

A Var containing the response property value if successful, is_undefined Var if an input parameter is invalid.

Referenced by GetHeaders(), GetRedirectMethod(), GetRedirectURL(), GetStatusCode(), GetStatusLine(), and GetURL().

Var pp::URLResponseInfo::GetRedirectMethod ( ) const

inline

This function gets the PP_URLRESPONSEPROPERTY_REDIRECTMETHOD property for the response.

Returns

An is_string Var containing the response property value if successful, is_undefined Var if an input parameter is invalid.

Definition at line 84 of file url_response_info.h.

References GetProperty().

Var pp::URLResponseInfo::GetRedirectURL ( ) const

inline

This function gets the PP_URLRESPONSEPROPERTY_REDIRECTURL property for the response.

Returns

An is_string Var containing the response property value if successful, is_undefined Var if an input parameter is invalid.

Definition at line 74 of file url_response_info.h.

References GetProperty().

int32_t pp::URLResponseInfo::GetStatusCode ( ) const

inline

This function gets the PP_URLRESPONSEPROPERTY_STATUSCODE property for the response.

Returns

A int32_t containing the response property value if successful, is_undefined Var if an input parameter is invalid.

Definition at line 93 of file url_response_info.h.

References pp::Var::AsInt(), and GetProperty().

Var pp::URLResponseInfo::GetStatusLine ( ) const

inline

This function gets the PP_URLRESPONSEPROPERTY_STATUSLINE property for the response.

Returns

An is_string Var containing the response property value if successful, is_undefined Var if an input parameter is invalid.

Definition at line 103 of file url_response_info.h.

References GetProperty().

Var pp::URLResponseInfo::GetURL ( ) const

inline

This function gets the PP_URLRESPONSEPROPERTY_URL property for the response.

Returns

An is_string Var containing the response property value if successful, is_undefined Var if an input parameter is invalid.

Definition at line 64 of file url_response_info.h.

References GetProperty().

---

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

• url_response_info.h