google_youtube_api::SearchResult Class Reference

#include <search_result.h>

Inheritance diagram for google_youtube_api::SearchResult:

Public Member Functions
	SearchResult (const Json::Value &storage)
	SearchResult (Json::Value *storage)
virtual	~SearchResult ()
const StringPiece	GetTypeName () const
bool	has_etag () const
void	clear_etag ()
const StringPiece	get_etag () const
void	set_etag (const StringPiece &value)
bool	has_id () const
void	clear_id ()
const ResourceId	get_id () const
ResourceId	mutable_id ()
bool	has_kind () const
void	clear_kind ()
const StringPiece	get_kind () const
void	set_kind (const StringPiece &value)
bool	has_snippet () const
void	clear_snippet ()
const SearchResultSnippet	get_snippet () const
SearchResultSnippet	mutable_snippet ()

Static Public Member Functions
static SearchResult *	New ()

Detailed Description

A search result contains information about a YouTube video, channel, or playlist that matches the search parameters specified in an API request. While a search result points to a uniquely identifiable resource, like a video, it does not have its own persistent data.

Constructor & Destructor Documentation

SearchResult() [1/2]

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

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

SearchResult() [2/2]

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

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~SearchResult()

google_youtube_api::SearchResult::~SearchResult ( )

virtual

Standard destructor.

Member Function Documentation

clear_etag()

void google_youtube_api::SearchResult::clear_etag ( )

inline

Clears the 'etag' attribute.

clear_id()

void google_youtube_api::SearchResult::clear_id ( )

inline

Clears the 'id' attribute.

clear_kind()

void google_youtube_api::SearchResult::clear_kind ( )

inline

Clears the 'kind' attribute.

clear_snippet()

void google_youtube_api::SearchResult::clear_snippet ( )

inline

Clears the 'snippet' attribute.

get_etag()

const StringPiece google_youtube_api::SearchResult::get_etag ( ) const

inline

Get the value of the 'etag' attribute.

get_id()

const ResourceId google_youtube_api::SearchResult::get_id

(

)

const

Get a reference to the value of the 'id' attribute.

get_kind()

const StringPiece google_youtube_api::SearchResult::get_kind ( ) const

inline

Get the value of the 'kind' attribute.

get_snippet()

const SearchResultSnippet google_youtube_api::SearchResult::get_snippet

(

)

const

Get a reference to the value of the 'snippet' attribute.

GetTypeName()

const StringPiece google_youtube_api::SearchResult::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_youtube_api::SearchResult

has_etag()

bool google_youtube_api::SearchResult::has_etag ( ) const

inline

Determine if the 'etag' attribute was set.

Returns

true if the 'etag' attribute was set.

has_id()

bool google_youtube_api::SearchResult::has_id ( ) const

inline

Determine if the 'id' attribute was set.

Returns

true if the 'id' attribute was set.

has_kind()

bool google_youtube_api::SearchResult::has_kind ( ) const

inline

Determine if the 'kind' attribute was set.

Returns

true if the 'kind' attribute was set.

has_snippet()

bool google_youtube_api::SearchResult::has_snippet ( ) const

inline

Determine if the 'snippet' attribute was set.

Returns

true if the 'snippet' attribute was set.

mutable_id()

ResourceId google_youtube_api::SearchResult::mutable_id

(

)

Gets a reference to a mutable value of the 'id' property.

The id object contains information that can be used to uniquely identify the resource that matches the search request.

Returns

The result can be modified to change the attribute value.

mutable_snippet()

SearchResultSnippet google_youtube_api::SearchResult::mutable_snippet

(

)

Gets a reference to a mutable value of the 'snippet' property.

The snippet object contains basic details about a search result, such as its title or description. For example, if the search result is a video, then the title will be the video's title and the description will be the video's description.

Returns

The result can be modified to change the attribute value.

New()

SearchResult * google_youtube_api::SearchResult::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_etag()

void google_youtube_api::SearchResult::set_etag ( const StringPiece &  value )

inline

Change the 'etag' attribute.

Etag of this resource.

Parameters

[in]

value

The new value.

set_kind()

void google_youtube_api::SearchResult::set_kind ( const StringPiece &  value )

inline

Change the 'kind' attribute.

Identifies what kind of resource this is. Value: the fixed string "youtube#searchResult".

Parameters

[in]

value

The new value.

---

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

• google/youtube_api/search_result.h
• google/youtube_api/search_result.cc