youtube  v3
Public Member Functions | List of all members
google_youtube_api::VideosResource_ReportAbuseMethod Class Reference
YouTube Data API Service Methods

#include <you_tube_service.h>

Inheritance diagram for google_youtube_api::VideosResource_ReportAbuseMethod:
google_youtube_api::YouTubeServiceBaseRequest

Public Member Functions

 VideosResource_ReportAbuseMethod (const YouTubeService *_service_, client::AuthorizationCredential *_credential_, const VideoAbuseReport &_content_)
 
virtual ~VideosResource_ReportAbuseMethod ()
 
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)
 
virtual util::Status AppendVariable (const StringPiece &variable_name, const client::UriTemplateConfig &config, string *target)
 
virtual util::Status AppendOptionalQueryParameters (string *target)
 
- 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 reportAbuse 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 https://www.googleapis.com/auth/youtube.force-ssl https://www.googleapis.com/auth/youtubepartner

Constructor & Destructor Documentation

◆ VideosResource_ReportAbuseMethod()

google_youtube_api::VideosResource_ReportAbuseMethod::VideosResource_ReportAbuseMethod ( const YouTubeService *  _service_,
client::AuthorizationCredential *  _credential_,
const VideoAbuseReport &  _content_ 
)

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]<em>content</em>The data object to reportAbuse.

◆ ~VideosResource_ReportAbuseMethod()

google_youtube_api::VideosResource_ReportAbuseMethod::~VideosResource_ReportAbuseMethod ( )
virtual

Standard destructor.

Member Function Documentation

◆ AppendOptionalQueryParameters()

util::Status google_youtube_api::VideosResource_ReportAbuseMethod::AppendOptionalQueryParameters ( string *  target)
virtual

Appends the optional query parameters to the target URL.

Parameters
[in,out]targetThe URL string to append to.

Reimplemented from google_youtube_api::YouTubeServiceBaseRequest.

◆ AppendVariable()

util::Status google_youtube_api::VideosResource_ReportAbuseMethod::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_nameThe name of the templated variable.
[in]configA pass-through parameter used for lists and maps.
[in,out]targetThe string to append the value to.

Reimplemented from google_youtube_api::YouTubeServiceBaseRequest.

◆ clear_on_behalf_of_content_owner()

void google_youtube_api::VideosResource_ReportAbuseMethod::clear_on_behalf_of_content_owner ( )
inline

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

◆ get_on_behalf_of_content_owner()

const string& google_youtube_api::VideosResource_ReportAbuseMethod::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.

◆ mutable_onBehalfOfContentOwner()

string* google_youtube_api::VideosResource_ReportAbuseMethod::mutable_onBehalfOfContentOwner ( )
inline

Gets a modifiable pointer to the optional onBehalfOfContentOwner' attribute.

Returns
The value can be set by dereferencing the pointer.

◆ set_on_behalf_of_content_owner()

void google_youtube_api::VideosResource_ReportAbuseMethod::set_on_behalf_of_content_owner ( const string &  value)
inline

Sets the 'onBehalfOfContentOwner' attribute.

Parameters
[in]valueNote: 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 CMS account that the user authenticates with must be linked to the specified YouTube content owner.

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