#include <you_tube_service.h>

Inheritance diagram for google_youtube_api::CaptionsResource_DownloadMethod:

Public Member Functions
	CaptionsResource_DownloadMethod (const YouTubeService _service_, client::AuthorizationCredential _credential_, const absl::string_view &id)

virtual	~CaptionsResource_DownloadMethod ()

void	clear_on_behalf_of ()

const string &	get_on_behalf_of () const

string *	mutable_onBehalfOf ()

void	set_on_behalf_of (const string &value)

void	clear_on_behalf_of_content_owner ()

const string &	get_on_behalf_of_content_owner () const

string *	mutable_onBehalfOfContentOwner ()

void	set_on_behalf_of_content_owner (const string &value)

void	clear_tfmt ()

const string &	get_tfmt () const

string *	mutable_tfmt ()

void	set_tfmt (const string &value)

void	clear_tlang ()

const string &	get_tlang () const

string *	mutable_tlang ()

void	set_tlang (const string &value)

virtual util::Status	AppendVariable (const StringPiece &variable_name, const client::UriTemplateConfig &config, string *target)

virtual util::Status	AppendOptionalQueryParameters (string *target)

bool	get_use_media_download () const

void	set_use_media_download (bool use)

Public Member Functions inherited from google_youtube_api::YouTubeServiceBaseRequest
	YouTubeServiceBaseRequest (const client::ClientService service, client::AuthorizationCredential credential, client::HttpRequest::HttpMethod method, const StringPiece &uri_template)

virtual	~YouTubeServiceBaseRequest ()

void	clear_alt ()

const string &	get_alt () const

string *	mutable_alt ()

void	set_alt (const string &value)

void	clear_fields ()

const string &	get_fields () const

string *	mutable_fields ()

void	set_fields (const string &value)

void	clear_key ()

const string &	get_key () const

string *	mutable_key ()

void	set_key (const string &value)

void	clear_oauth_token ()

const string &	get_oauth_token () const

string *	mutable_oauthToken ()

void	set_oauth_token (const string &value)

void	clear_pretty_print ()

bool	get_pretty_print () const

void	set_pretty_print (bool value)

void	clear_quota_user ()

const string &	get_quota_user () const

string *	mutable_quotaUser ()

void	set_quota_user (const string &value)

void	clear_user_ip ()

const string &	get_user_ip () const

string *	mutable_userIp ()

void	set_user_ip (const string &value)

Additional Inherited Members
Protected Member Functions inherited from google_youtube_api::YouTubeServiceBaseRequest
void	AddJsonContentToRequest (const client::JsonCppData *content)

Detailed Description

Implements the download method.

This class uses the Command Pattern. Construct an instance with the required parameters, then set any additional optional parameters by using the attribute setters. To invoke the method, call Execute.

One or more of these authorization scopes are required for this method: https://www.googleapis.com/auth/youtube.force-ssl https://www.googleapis.com/auth/youtubepartner

Constructor & Destructor Documentation

◆ CaptionsResource_DownloadMethod()

google_youtube_api::CaptionsResource_DownloadMethod::CaptionsResource_DownloadMethod	(	const YouTubeService *	_service_,
		client::AuthorizationCredential *	_credential_,
		const absl::string_view &	id
	)

The standard constructor takes all the required method parameters.

Parameters

[in]	<em>service</em>	The service instance to send to when executed.
[in]	<em>credential</em>	If not NULL, the credential to authorize with. In practice this is supplied by the user code that is creating the method instance.
[in]	id	The id parameter identifies the caption track that is being retrieved. The value is a caption track ID as identified by the id property in a caption resource.

◆ ~CaptionsResource_DownloadMethod()

google_youtube_api::CaptionsResource_DownloadMethod::~CaptionsResource_DownloadMethod ( )

virtual

Standard destructor.

Member Function Documentation

◆ AppendOptionalQueryParameters()

util::Status google_youtube_api::CaptionsResource_DownloadMethod::AppendOptionalQueryParameters ( string * target )

virtual

Appends the optional query parameters to the target URL.

Parameters

[in,out] target The URL string to append to.

Reimplemented from google_youtube_api::YouTubeServiceBaseRequest.

◆ AppendVariable()

util::Status google_youtube_api::CaptionsResource_DownloadMethod::AppendVariable	(	const StringPiece &	variable_name,
		const client::UriTemplateConfig &	config,
		string *	target
	)

virtual

Appends variable value to the target string.

This is a helper function used to resolve templated variables in the URI.

Parameters

[in]	variable_name	The name of the templated variable.
[in]	config	A pass-through parameter used for lists and maps.
[in,out]	target	The string to append the value to.

Reimplemented from google_youtube_api::YouTubeServiceBaseRequest.

◆ clear_on_behalf_of()

void google_youtube_api::CaptionsResource_DownloadMethod::clear_on_behalf_of ( )

inline

Clears the 'onBehalfOf' attribute so it is no longer set.

◆ clear_on_behalf_of_content_owner()

void google_youtube_api::CaptionsResource_DownloadMethod::clear_on_behalf_of_content_owner ( )

inline

Clears the 'onBehalfOfContentOwner' attribute so it is no longer set.

◆ clear_tfmt()

void google_youtube_api::CaptionsResource_DownloadMethod::clear_tfmt ( )

inline

Clears the 'tfmt' attribute so it is no longer set.

◆ clear_tlang()

void google_youtube_api::CaptionsResource_DownloadMethod::clear_tlang ( )

inline

Clears the 'tlang' attribute so it is no longer set.

◆ get_on_behalf_of()

const string& google_youtube_api::CaptionsResource_DownloadMethod::get_on_behalf_of ( ) const

inline

Gets the optional 'onBehalfOf' attribute.

If the value is not set then the default value will be returned.

◆ get_on_behalf_of_content_owner()

const string& google_youtube_api::CaptionsResource_DownloadMethod::get_on_behalf_of_content_owner ( ) const

inline

Gets the optional 'onBehalfOfContentOwner' attribute.

If the value is not set then the default value will be returned.

◆ get_tfmt()

const string& google_youtube_api::CaptionsResource_DownloadMethod::get_tfmt ( ) const

inline

Gets the optional 'tfmt' attribute.

If the value is not set then the default value will be returned.

◆ get_tlang()

const string& google_youtube_api::CaptionsResource_DownloadMethod::get_tlang ( ) const

inline

Gets the optional 'tlang' attribute.

If the value is not set then the default value will be returned.

◆ get_use_media_download()

bool google_youtube_api::CaptionsResource_DownloadMethod::get_use_media_download ( ) const

inline

Determine if the request should use Media Download for the response.

Returns: true for media download, false otherwise.

◆ mutable_onBehalfOf()

string* google_youtube_api::CaptionsResource_DownloadMethod::mutable_onBehalfOf ( )

inline

Gets a modifiable pointer to the optional onBehalfOf' attribute.

Returns: The value can be set by dereferencing the pointer.

◆ mutable_onBehalfOfContentOwner()

string* google_youtube_api::CaptionsResource_DownloadMethod::mutable_onBehalfOfContentOwner ( )

inline

Gets a modifiable pointer to the optional onBehalfOfContentOwner' attribute.

Returns: The value can be set by dereferencing the pointer.

◆ mutable_tfmt()

string* google_youtube_api::CaptionsResource_DownloadMethod::mutable_tfmt ( )

inline

Gets a modifiable pointer to the optional tfmt' attribute.

Returns: The value can be set by dereferencing the pointer.

◆ mutable_tlang()

string* google_youtube_api::CaptionsResource_DownloadMethod::mutable_tlang ( )

inline

Gets a modifiable pointer to the optional tlang' attribute.

Returns: The value can be set by dereferencing the pointer.

◆ set_on_behalf_of()

void google_youtube_api::CaptionsResource_DownloadMethod::set_on_behalf_of ( const string & value )

inline

Sets the 'onBehalfOf' attribute.

Parameters

[in] value ID of the Google+ Page for the channel that the request is be on behalf of.

◆ set_on_behalf_of_content_owner()

void google_youtube_api::CaptionsResource_DownloadMethod::set_on_behalf_of_content_owner ( const string & value )

inline

Sets the 'onBehalfOfContentOwner' attribute.

Parameters

[in] value Note: This parameter is intended exclusively for YouTube content partners.

The onBehalfOfContentOwner parameter indicates that the request's authorization credentials identify a YouTube CMS user who is acting on behalf of the content owner specified in the parameter value. This parameter is intended for YouTube content partners that own and manage many different YouTube channels. It allows content owners to authenticate once and get access to all their video and channel data, without having to provide authentication credentials for each individual channel. The actual CMS account that the user authenticates with must be linked to the specified YouTube content owner.

◆ set_tfmt()

void google_youtube_api::CaptionsResource_DownloadMethod::set_tfmt ( const string & value )

inline

Sets the 'tfmt' attribute.

Parameters

[in] value The tfmt parameter specifies that the caption track should be returned in a specific format. If the parameter is not included in the request, the track is returned in its original format.

◆ set_tlang()

void google_youtube_api::CaptionsResource_DownloadMethod::set_tlang ( const string & value )

inline

Sets the 'tlang' attribute.

Parameters

[in] value The tlang parameter specifies that the API response should return a translation of the specified caption track. The parameter value is an ISO 639-1 two-letter language code that identifies the desired caption language. The translation is generated by using machine translation, such as Google Translate.

◆ set_use_media_download()

void google_youtube_api::CaptionsResource_DownloadMethod::set_use_media_download ( bool use )

inline

Sets whether Media Download should be used for the response data.

Parameters

[in] use true to use media download, false otherwise.

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

google/youtube_api/you_tube_service.h
google/youtube_api/you_tube_service.cc

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CaptionsResource_DownloadMethod()

◆ ~CaptionsResource_DownloadMethod()

Member Function Documentation

◆ AppendOptionalQueryParameters()

◆ AppendVariable()

◆ clear_on_behalf_of()

◆ clear_on_behalf_of_content_owner()

◆ clear_tfmt()

◆ clear_tlang()

◆ get_on_behalf_of()

◆ get_on_behalf_of_content_owner()

◆ get_tfmt()

◆ get_tlang()

◆ get_use_media_download()

◆ mutable_onBehalfOf()

◆ mutable_onBehalfOfContentOwner()

◆ mutable_tfmt()

◆ mutable_tlang()

◆ set_on_behalf_of()

◆ set_on_behalf_of_content_owner()

◆ set_tfmt()

◆ set_tlang()

◆ set_use_media_download()