google_youtube_api::PageInfo Class Reference

#include <page_info.h>

Inheritance diagram for google_youtube_api::PageInfo:

Public Member Functions
	PageInfo (const Json::Value &storage)
	PageInfo (Json::Value *storage)
virtual	~PageInfo ()
const StringPiece	GetTypeName () const
bool	has_results_per_page () const
void	clear_results_per_page ()
int32	get_results_per_page () const
void	set_results_per_page (int32 value)
bool	has_total_results () const
void	clear_total_results ()
int32	get_total_results () const
void	set_total_results (int32 value)

Static Public Member Functions
static PageInfo *	New ()

Detailed Description

Paging details for lists of resources, including total number of items available and number of resources returned in a single page.

Constructor & Destructor Documentation

PageInfo() [1/2]

google_youtube_api::PageInfo::PageInfo ( const Json::Value &  storage )

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

PageInfo() [2/2]

google_youtube_api::PageInfo::PageInfo ( Json::Value *  storage )

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~PageInfo()

google_youtube_api::PageInfo::~PageInfo ( )

virtual

Standard destructor.

Member Function Documentation

clear_results_per_page()

void google_youtube_api::PageInfo::clear_results_per_page ( )

inline

Clears the 'resultsPerPage' attribute.

clear_total_results()

void google_youtube_api::PageInfo::clear_total_results ( )

inline

Clears the 'totalResults' attribute.

get_results_per_page()

int32 google_youtube_api::PageInfo::get_results_per_page ( ) const

inline

Get the value of the 'resultsPerPage' attribute.

get_total_results()

int32 google_youtube_api::PageInfo::get_total_results ( ) const

inline

Get the value of the 'totalResults' attribute.

GetTypeName()

const StringPiece google_youtube_api::PageInfo::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_youtube_api::PageInfo

has_results_per_page()

bool google_youtube_api::PageInfo::has_results_per_page ( ) const

inline

Determine if the 'resultsPerPage' attribute was set.

Returns

true if the 'resultsPerPage' attribute was set.

has_total_results()

bool google_youtube_api::PageInfo::has_total_results ( ) const

inline

Determine if the 'totalResults' attribute was set.

Returns

true if the 'totalResults' attribute was set.

New()

PageInfo * google_youtube_api::PageInfo::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_results_per_page()

void google_youtube_api::PageInfo::set_results_per_page ( int32  value )

inline

Change the 'resultsPerPage' attribute.

The number of results included in the API response.

Parameters

[in]

value

The new value.

set_total_results()

void google_youtube_api::PageInfo::set_total_results ( int32  value )

inline

Change the 'totalResults' attribute.

The total number of results in the result set.

Parameters

[in]

value

The new value.

---

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

• google/youtube_api/page_info.h
• google/youtube_api/page_info.cc