youtube  v3
Public Member Functions | Protected Member Functions | List of all members
google_youtube_api::YouTubeServiceBaseRequest Class Reference

#include <you_tube_service.h>

Inheritance diagram for google_youtube_api::YouTubeServiceBaseRequest:
google_youtube_api::ActivitiesResource_InsertMethod google_youtube_api::ActivitiesResource_ListMethod google_youtube_api::CaptionsResource_DeleteMethod google_youtube_api::CaptionsResource_DownloadMethod google_youtube_api::CaptionsResource_InsertMethod google_youtube_api::CaptionsResource_ListMethod google_youtube_api::CaptionsResource_UpdateMethod google_youtube_api::ChannelBannersResource_InsertMethod google_youtube_api::ChannelSectionsResource_DeleteMethod google_youtube_api::ChannelSectionsResource_InsertMethod google_youtube_api::ChannelSectionsResource_ListMethod google_youtube_api::ChannelSectionsResource_UpdateMethod google_youtube_api::ChannelsResource_ListMethod google_youtube_api::ChannelsResource_UpdateMethod google_youtube_api::CommentsResource_DeleteMethod google_youtube_api::CommentsResource_InsertMethod google_youtube_api::CommentsResource_ListMethod google_youtube_api::CommentsResource_MarkAsSpamMethod google_youtube_api::CommentsResource_SetModerationStatusMethod google_youtube_api::CommentsResource_UpdateMethod google_youtube_api::CommentThreadsResource_InsertMethod google_youtube_api::CommentThreadsResource_ListMethod google_youtube_api::CommentThreadsResource_UpdateMethod google_youtube_api::GuideCategoriesResource_ListMethod google_youtube_api::I18nLanguagesResource_ListMethod google_youtube_api::I18nRegionsResource_ListMethod google_youtube_api::LiveBroadcastsResource_BindMethod google_youtube_api::LiveBroadcastsResource_ControlMethod google_youtube_api::LiveBroadcastsResource_DeleteMethod google_youtube_api::LiveBroadcastsResource_InsertMethod google_youtube_api::LiveBroadcastsResource_ListMethod google_youtube_api::LiveBroadcastsResource_TransitionMethod google_youtube_api::LiveBroadcastsResource_UpdateMethod google_youtube_api::LiveChatBansResource_DeleteMethod google_youtube_api::LiveChatBansResource_InsertMethod google_youtube_api::LiveChatMessagesResource_DeleteMethod google_youtube_api::LiveChatMessagesResource_InsertMethod google_youtube_api::LiveChatMessagesResource_ListMethod google_youtube_api::LiveChatModeratorsResource_DeleteMethod google_youtube_api::LiveChatModeratorsResource_InsertMethod google_youtube_api::LiveChatModeratorsResource_ListMethod google_youtube_api::LiveStreamsResource_DeleteMethod google_youtube_api::LiveStreamsResource_InsertMethod google_youtube_api::LiveStreamsResource_ListMethod google_youtube_api::LiveStreamsResource_UpdateMethod google_youtube_api::MembershipsLevelsResource_ListMethod google_youtube_api::MembersResource_ListMethod google_youtube_api::PlaylistItemsResource_DeleteMethod google_youtube_api::PlaylistItemsResource_InsertMethod google_youtube_api::PlaylistItemsResource_ListMethod google_youtube_api::PlaylistItemsResource_UpdateMethod google_youtube_api::PlaylistsResource_DeleteMethod google_youtube_api::PlaylistsResource_InsertMethod google_youtube_api::PlaylistsResource_ListMethod google_youtube_api::PlaylistsResource_UpdateMethod google_youtube_api::SearchResource_ListMethod google_youtube_api::SponsorsResource_ListMethod google_youtube_api::SubscriptionsResource_DeleteMethod google_youtube_api::SubscriptionsResource_InsertMethod google_youtube_api::SubscriptionsResource_ListMethod google_youtube_api::SuperChatEventsResource_ListMethod google_youtube_api::ThumbnailsResource_SetMethod google_youtube_api::VideoAbuseReportReasonsResource_ListMethod google_youtube_api::VideoCategoriesResource_ListMethod google_youtube_api::VideosResource_DeleteMethod google_youtube_api::VideosResource_GetRatingMethod google_youtube_api::VideosResource_InsertMethod google_youtube_api::VideosResource_ListMethod google_youtube_api::VideosResource_RateMethod google_youtube_api::VideosResource_ReportAbuseMethod google_youtube_api::VideosResource_UpdateMethod google_youtube_api::WatermarksResource_SetMethod google_youtube_api::WatermarksResource_UnsetMethod

Public Member Functions

 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)
 
virtual util::Status AppendVariable (const StringPiece &variable_name, const client::UriTemplateConfig &config, string *target)
 
virtual util::Status AppendOptionalQueryParameters (string *target)
 

Protected Member Functions

void AddJsonContentToRequest (const client::JsonCppData *content)
 

Detailed Description

Implements a common base method for all methods within the YouTubeService.

This class defines all the attributes common across all methods. It does not pertain to any specific service API so is not normally explicitly instantiated.

Constructor & Destructor Documentation

◆ YouTubeServiceBaseRequest()

google_youtube_api::YouTubeServiceBaseRequest::YouTubeServiceBaseRequest ( const client::ClientService *  service,
client::AuthorizationCredential *  credential,
client::HttpRequest::HttpMethod  method,
const StringPiece &  uri_template 
)

Standard constructor.

Parameters
[in]serviceThe service instance to send to when executed. In practice this will be supplied internally by the service when it acts as a method factory.
[in]credentialIf not NULL then the credential to authorize with. In practice this is supplied by the user code that is creating the method instance.
[in]methodThe HTTP method to use for the underlying HTTP request. In practice this is specified by the particular API endpoint and supplied internally by the derived class for that endpoint.
[in]uri_templateThe RFC 6570 URI Template specifying the url to invoke The parameters in the template should be resolvable attributes. In practice this parameter is supplied internally by the derived class for the endpoint.

◆ ~YouTubeServiceBaseRequest()

google_youtube_api::YouTubeServiceBaseRequest::~YouTubeServiceBaseRequest ( )
virtual

Standard destructor.

Member Function Documentation

◆ AddJsonContentToRequest()

void google_youtube_api::YouTubeServiceBaseRequest::AddJsonContentToRequest ( const client::JsonCppData *  content)
protected

Prepares the method's HTTP request to send body content as JSON.

Only to be used for method constructors.

◆ AppendOptionalQueryParameters()

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

Appends the optional query parameters to the target URL.

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

Reimplemented in google_youtube_api::WatermarksResource_UnsetMethod, google_youtube_api::WatermarksResource_SetMethod, google_youtube_api::VideosResource_UpdateMethod, google_youtube_api::VideosResource_ReportAbuseMethod, google_youtube_api::VideosResource_RateMethod, google_youtube_api::VideosResource_ListMethod, google_youtube_api::VideosResource_InsertMethod, google_youtube_api::VideosResource_GetRatingMethod, google_youtube_api::VideosResource_DeleteMethod, google_youtube_api::VideoCategoriesResource_ListMethod, google_youtube_api::VideoAbuseReportReasonsResource_ListMethod, google_youtube_api::ThumbnailsResource_SetMethod, google_youtube_api::SuperChatEventsResource_ListMethod, google_youtube_api::SubscriptionsResource_ListMethod, google_youtube_api::SubscriptionsResource_InsertMethod, google_youtube_api::SubscriptionsResource_DeleteMethod, google_youtube_api::SponsorsResource_ListMethod, google_youtube_api::SearchResource_ListMethod, google_youtube_api::PlaylistsResource_UpdateMethod, google_youtube_api::PlaylistsResource_ListMethod, google_youtube_api::PlaylistsResource_InsertMethod, google_youtube_api::PlaylistsResource_DeleteMethod, google_youtube_api::PlaylistItemsResource_UpdateMethod, google_youtube_api::PlaylistItemsResource_ListMethod, google_youtube_api::PlaylistItemsResource_InsertMethod, google_youtube_api::PlaylistItemsResource_DeleteMethod, google_youtube_api::MembershipsLevelsResource_ListMethod, google_youtube_api::MembersResource_ListMethod, google_youtube_api::LiveStreamsResource_UpdateMethod, google_youtube_api::LiveStreamsResource_ListMethod, google_youtube_api::LiveStreamsResource_InsertMethod, google_youtube_api::LiveStreamsResource_DeleteMethod, google_youtube_api::LiveChatModeratorsResource_ListMethod, google_youtube_api::LiveChatModeratorsResource_InsertMethod, google_youtube_api::LiveChatModeratorsResource_DeleteMethod, google_youtube_api::LiveChatMessagesResource_ListMethod, google_youtube_api::LiveChatMessagesResource_InsertMethod, google_youtube_api::LiveChatMessagesResource_DeleteMethod, google_youtube_api::LiveChatBansResource_InsertMethod, google_youtube_api::LiveChatBansResource_DeleteMethod, google_youtube_api::LiveBroadcastsResource_UpdateMethod, google_youtube_api::LiveBroadcastsResource_TransitionMethod, google_youtube_api::LiveBroadcastsResource_ListMethod, google_youtube_api::LiveBroadcastsResource_InsertMethod, google_youtube_api::LiveBroadcastsResource_DeleteMethod, google_youtube_api::LiveBroadcastsResource_ControlMethod, google_youtube_api::LiveBroadcastsResource_BindMethod, google_youtube_api::I18nRegionsResource_ListMethod, google_youtube_api::I18nLanguagesResource_ListMethod, google_youtube_api::GuideCategoriesResource_ListMethod, google_youtube_api::CommentsResource_UpdateMethod, google_youtube_api::CommentsResource_SetModerationStatusMethod, google_youtube_api::CommentsResource_MarkAsSpamMethod, google_youtube_api::CommentsResource_ListMethod, google_youtube_api::CommentsResource_InsertMethod, google_youtube_api::CommentsResource_DeleteMethod, google_youtube_api::CommentThreadsResource_UpdateMethod, google_youtube_api::CommentThreadsResource_ListMethod, google_youtube_api::CommentThreadsResource_InsertMethod, google_youtube_api::ChannelsResource_UpdateMethod, google_youtube_api::ChannelsResource_ListMethod, google_youtube_api::ChannelSectionsResource_UpdateMethod, google_youtube_api::ChannelSectionsResource_ListMethod, google_youtube_api::ChannelSectionsResource_InsertMethod, google_youtube_api::ChannelSectionsResource_DeleteMethod, google_youtube_api::ChannelBannersResource_InsertMethod, google_youtube_api::CaptionsResource_UpdateMethod, google_youtube_api::CaptionsResource_ListMethod, google_youtube_api::CaptionsResource_InsertMethod, google_youtube_api::CaptionsResource_DownloadMethod, google_youtube_api::CaptionsResource_DeleteMethod, google_youtube_api::ActivitiesResource_ListMethod, and google_youtube_api::ActivitiesResource_InsertMethod.

◆ AppendVariable()

util::Status google_youtube_api::YouTubeServiceBaseRequest::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 supplied to the constructor.

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 in google_youtube_api::WatermarksResource_UnsetMethod, google_youtube_api::WatermarksResource_SetMethod, google_youtube_api::VideosResource_UpdateMethod, google_youtube_api::VideosResource_ReportAbuseMethod, google_youtube_api::VideosResource_RateMethod, google_youtube_api::VideosResource_ListMethod, google_youtube_api::VideosResource_InsertMethod, google_youtube_api::VideosResource_GetRatingMethod, google_youtube_api::VideosResource_DeleteMethod, google_youtube_api::VideoCategoriesResource_ListMethod, google_youtube_api::VideoAbuseReportReasonsResource_ListMethod, google_youtube_api::ThumbnailsResource_SetMethod, google_youtube_api::SuperChatEventsResource_ListMethod, google_youtube_api::SubscriptionsResource_ListMethod, google_youtube_api::SubscriptionsResource_InsertMethod, google_youtube_api::SubscriptionsResource_DeleteMethod, google_youtube_api::SponsorsResource_ListMethod, google_youtube_api::SearchResource_ListMethod, google_youtube_api::PlaylistsResource_UpdateMethod, google_youtube_api::PlaylistsResource_ListMethod, google_youtube_api::PlaylistsResource_InsertMethod, google_youtube_api::PlaylistsResource_DeleteMethod, google_youtube_api::PlaylistItemsResource_UpdateMethod, google_youtube_api::PlaylistItemsResource_ListMethod, google_youtube_api::PlaylistItemsResource_InsertMethod, google_youtube_api::PlaylistItemsResource_DeleteMethod, google_youtube_api::MembershipsLevelsResource_ListMethod, google_youtube_api::MembersResource_ListMethod, google_youtube_api::LiveStreamsResource_UpdateMethod, google_youtube_api::LiveStreamsResource_ListMethod, google_youtube_api::LiveStreamsResource_InsertMethod, google_youtube_api::LiveStreamsResource_DeleteMethod, google_youtube_api::LiveChatModeratorsResource_ListMethod, google_youtube_api::LiveChatModeratorsResource_InsertMethod, google_youtube_api::LiveChatModeratorsResource_DeleteMethod, google_youtube_api::LiveChatMessagesResource_ListMethod, google_youtube_api::LiveChatMessagesResource_InsertMethod, google_youtube_api::LiveChatMessagesResource_DeleteMethod, google_youtube_api::LiveChatBansResource_InsertMethod, google_youtube_api::LiveChatBansResource_DeleteMethod, google_youtube_api::LiveBroadcastsResource_UpdateMethod, google_youtube_api::LiveBroadcastsResource_TransitionMethod, google_youtube_api::LiveBroadcastsResource_ListMethod, google_youtube_api::LiveBroadcastsResource_InsertMethod, google_youtube_api::LiveBroadcastsResource_DeleteMethod, google_youtube_api::LiveBroadcastsResource_ControlMethod, google_youtube_api::LiveBroadcastsResource_BindMethod, google_youtube_api::I18nRegionsResource_ListMethod, google_youtube_api::I18nLanguagesResource_ListMethod, google_youtube_api::GuideCategoriesResource_ListMethod, google_youtube_api::CommentsResource_UpdateMethod, google_youtube_api::CommentsResource_SetModerationStatusMethod, google_youtube_api::CommentsResource_MarkAsSpamMethod, google_youtube_api::CommentsResource_ListMethod, google_youtube_api::CommentsResource_InsertMethod, google_youtube_api::CommentsResource_DeleteMethod, google_youtube_api::CommentThreadsResource_UpdateMethod, google_youtube_api::CommentThreadsResource_ListMethod, google_youtube_api::CommentThreadsResource_InsertMethod, google_youtube_api::ChannelsResource_UpdateMethod, google_youtube_api::ChannelsResource_ListMethod, google_youtube_api::ChannelSectionsResource_UpdateMethod, google_youtube_api::ChannelSectionsResource_ListMethod, google_youtube_api::ChannelSectionsResource_InsertMethod, google_youtube_api::ChannelSectionsResource_DeleteMethod, google_youtube_api::ChannelBannersResource_InsertMethod, google_youtube_api::CaptionsResource_UpdateMethod, google_youtube_api::CaptionsResource_ListMethod, google_youtube_api::CaptionsResource_InsertMethod, google_youtube_api::CaptionsResource_DownloadMethod, google_youtube_api::CaptionsResource_DeleteMethod, google_youtube_api::ActivitiesResource_ListMethod, and google_youtube_api::ActivitiesResource_InsertMethod.

◆ clear_alt()

void google_youtube_api::YouTubeServiceBaseRequest::clear_alt ( )
inline

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

◆ clear_fields()

void google_youtube_api::YouTubeServiceBaseRequest::clear_fields ( )
inline

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

◆ clear_key()

void google_youtube_api::YouTubeServiceBaseRequest::clear_key ( )
inline

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

◆ clear_oauth_token()

void google_youtube_api::YouTubeServiceBaseRequest::clear_oauth_token ( )
inline

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

◆ clear_pretty_print()

void google_youtube_api::YouTubeServiceBaseRequest::clear_pretty_print ( )
inline

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

◆ clear_quota_user()

void google_youtube_api::YouTubeServiceBaseRequest::clear_quota_user ( )
inline

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

◆ clear_user_ip()

void google_youtube_api::YouTubeServiceBaseRequest::clear_user_ip ( )
inline

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

◆ get_alt()

const string& google_youtube_api::YouTubeServiceBaseRequest::get_alt ( ) const
inline

Gets the optional 'alt' attribute.

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

◆ get_fields()

const string& google_youtube_api::YouTubeServiceBaseRequest::get_fields ( ) const
inline

Gets the optional 'fields' attribute.

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

◆ get_key()

const string& google_youtube_api::YouTubeServiceBaseRequest::get_key ( ) const
inline

Gets the optional 'key' attribute.

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

◆ get_oauth_token()

const string& google_youtube_api::YouTubeServiceBaseRequest::get_oauth_token ( ) const
inline

Gets the optional 'oauth_token' attribute.

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

◆ get_pretty_print()

bool google_youtube_api::YouTubeServiceBaseRequest::get_pretty_print ( ) const
inline

Gets the optional 'prettyPrint' attribute.

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

◆ get_quota_user()

const string& google_youtube_api::YouTubeServiceBaseRequest::get_quota_user ( ) const
inline

Gets the optional 'quotaUser' attribute.

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

◆ get_user_ip()

const string& google_youtube_api::YouTubeServiceBaseRequest::get_user_ip ( ) const
inline

Gets the optional 'userIp' attribute.

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

◆ mutable_alt()

string* google_youtube_api::YouTubeServiceBaseRequest::mutable_alt ( )
inline

Gets a modifiable pointer to the optional alt' attribute.

Returns
The value can be set by dereferencing the pointer.

◆ mutable_fields()

string* google_youtube_api::YouTubeServiceBaseRequest::mutable_fields ( )
inline

Gets a modifiable pointer to the optional fields' attribute.

Returns
The value can be set by dereferencing the pointer.

◆ mutable_key()

string* google_youtube_api::YouTubeServiceBaseRequest::mutable_key ( )
inline

Gets a modifiable pointer to the optional key' attribute.

Returns
The value can be set by dereferencing the pointer.

◆ mutable_oauthToken()

string* google_youtube_api::YouTubeServiceBaseRequest::mutable_oauthToken ( )
inline

Gets a modifiable pointer to the optional oauth_token' attribute.

Returns
The value can be set by dereferencing the pointer.

◆ mutable_quotaUser()

string* google_youtube_api::YouTubeServiceBaseRequest::mutable_quotaUser ( )
inline

Gets a modifiable pointer to the optional quotaUser' attribute.

Returns
The value can be set by dereferencing the pointer.

◆ mutable_userIp()

string* google_youtube_api::YouTubeServiceBaseRequest::mutable_userIp ( )
inline

Gets a modifiable pointer to the optional userIp' attribute.

Returns
The value can be set by dereferencing the pointer.

◆ set_alt()

void google_youtube_api::YouTubeServiceBaseRequest::set_alt ( const string &  value)
inline

Sets the 'alt' attribute.

Parameters
[in]valueData format for the response.

◆ set_fields()

void google_youtube_api::YouTubeServiceBaseRequest::set_fields ( const string &  value)
inline

Sets the 'fields' attribute.

Parameters
[in]valueSelector specifying which fields to include in a partial response.

◆ set_key()

void google_youtube_api::YouTubeServiceBaseRequest::set_key ( const string &  value)
inline

Sets the 'key' attribute.

Parameters
[in]valueAPI key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

◆ set_oauth_token()

void google_youtube_api::YouTubeServiceBaseRequest::set_oauth_token ( const string &  value)
inline

Sets the 'oauth_token' attribute.

Parameters
[in]valueOAuth 2.0 token for the current user.

◆ set_pretty_print()

void google_youtube_api::YouTubeServiceBaseRequest::set_pretty_print ( bool  value)
inline

Sets the 'prettyPrint' attribute.

Parameters
[in]valueReturns response with indentations and line breaks.

◆ set_quota_user()

void google_youtube_api::YouTubeServiceBaseRequest::set_quota_user ( const string &  value)
inline

Sets the 'quotaUser' attribute.

Parameters
[in]valueAn opaque string that represents a user for quota purposes. Must not exceed 40 characters.

◆ set_user_ip()

void google_youtube_api::YouTubeServiceBaseRequest::set_user_ip ( const string &  value)
inline

Sets the 'userIp' attribute.

Deprecated:
Parameters
[in]valueDeprecated. Please use quotaUser instead.

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