youtube  v3
Public Member Functions | List of all members
google_youtube_api::YouTubeService::CaptionsResource Class Reference

#include <you_tube_service.h>

Public Member Functions

 CaptionsResource (YouTubeService *service)
 
 ~CaptionsResource ()
 
CaptionsResource_DeleteMethodNewDeleteMethod (client::AuthorizationCredential *_credential_, const absl::string_view &id) const
 
CaptionsResource_DownloadMethodNewDownloadMethod (client::AuthorizationCredential *_credential_, const absl::string_view &id) const
 
CaptionsResource_InsertMethodNewInsertMethod (client::AuthorizationCredential *_credential_, const absl::string_view &part) const
 
CaptionsResource_InsertMethodNewInsertMethod (client::AuthorizationCredential *_credential_, const absl::string_view &part, const Caption *_metadata_, const StringPiece &_media_content_type_, client::DataReader *_media_content_reader_) const
 
CaptionsResource_ListMethodNewListMethod (client::AuthorizationCredential *_credential_, const absl::string_view &part, const absl::string_view &video_id) const
 
CaptionsResource_UpdateMethodNewUpdateMethod (client::AuthorizationCredential *_credential_, const absl::string_view &part) const
 
CaptionsResource_UpdateMethodNewUpdateMethod (client::AuthorizationCredential *_credential_, const absl::string_view &part, const Caption *_metadata_, const StringPiece &_media_content_type_, client::DataReader *_media_content_reader_) const
 

Detailed Description

Acts as message factory for accessing data.

Constructor & Destructor Documentation

◆ CaptionsResource()

google_youtube_api::YouTubeService::CaptionsResource::CaptionsResource ( YouTubeService service)
explicit

Standard constructor.

Parameters
[in]serviceThe service instance is used to bind to the methods created from this resource instance. This will be the service that methods are invoked on.

◆ ~CaptionsResource()

google_youtube_api::YouTubeService::CaptionsResource::~CaptionsResource ( )
inline

Standard destructor.

Member Function Documentation

◆ NewDeleteMethod()

CaptionsResource_DeleteMethod * google_youtube_api::YouTubeService::CaptionsResource::NewDeleteMethod ( client::AuthorizationCredential *  _credential_,
const absl::string_view &  id 
) const

Creates a new CaptionsResource_DeleteMethod instance.

Parameters
[in]<em>credential</em>Can be NULL. NULL credentials will not authorize the request.
[in]idThe id parameter identifies the caption track that is being deleted. The value is a caption track ID as identified by the id property in a caption resource.
Returns
The caller should Execute the method instance, then destroy it when they are finished.

◆ NewDownloadMethod()

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

Creates a new CaptionsResource_DownloadMethod instance.

Parameters
[in]<em>credential</em>Can be NULL. NULL credentials will not authorize the request.
[in]idThe 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.
Returns
The caller should Execute the method instance, then destroy it when they are finished.

◆ NewInsertMethod() [1/2]

CaptionsResource_InsertMethod * google_youtube_api::YouTubeService::CaptionsResource::NewInsertMethod ( client::AuthorizationCredential *  _credential_,
const absl::string_view &  part 
) const

Creates a new CaptionsResource_InsertMethod instance.

Deprecated:
Parameters
[in]<em>credential</em>Can be NULL. NULL credentials will not authorize the request.
[in]partThe part parameter specifies the caption resource parts that the API response will include. Set the parameter value to snippet.
Returns
The caller should Execute the method instance, then destroy it when they are finished.

◆ NewInsertMethod() [2/2]

CaptionsResource_InsertMethod * google_youtube_api::YouTubeService::CaptionsResource::NewInsertMethod ( client::AuthorizationCredential *  _credential_,
const absl::string_view &  part,
const Caption _metadata_,
const StringPiece &  _media_content_type_,
client::DataReader *  _media_content_reader_ 
) const

Creates a new CaptionsResource_InsertMethod instance.

Parameters
[in]<em>credential</em>Can be NULL. NULL credentials will not authorize the request.
[in]partThe part parameter specifies the caption resource parts that the API response will include. Set the parameter value to snippet.
[in]<em>metadata</em>The metadata object to insert. If this is NULL then do not upload any metadata.
[in]<em>media_content_type</em>The content type of the data in the media_content_reader.
[in]<em>media_content_reader</em>The media content to insert. If this is NULL then do not upload any media and ignore media_content_type.
Returns
The caller should Execute the method instance, then destroy it when they are finished.

◆ NewListMethod()

CaptionsResource_ListMethod * google_youtube_api::YouTubeService::CaptionsResource::NewListMethod ( client::AuthorizationCredential *  _credential_,
const absl::string_view &  part,
const absl::string_view &  video_id 
) const

Creates a new CaptionsResource_ListMethod instance.

Parameters
[in]<em>credential</em>Can be NULL. NULL credentials will not authorize the request.
[in]partThe part parameter specifies a comma-separated list of one or more caption resource parts that the API response will include. The part names that you can include in the parameter value are id and snippet.
[in]video_idThe videoId parameter specifies the YouTube video ID of the video for which the API should return caption tracks.
Returns
The caller should Execute the method instance, then destroy it when they are finished.

◆ NewUpdateMethod() [1/2]

CaptionsResource_UpdateMethod * google_youtube_api::YouTubeService::CaptionsResource::NewUpdateMethod ( client::AuthorizationCredential *  _credential_,
const absl::string_view &  part 
) const

Creates a new CaptionsResource_UpdateMethod instance.

Deprecated:
Parameters
[in]<em>credential</em>Can be NULL. NULL credentials will not authorize the request.
[in]partThe part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. Set the property value to snippet if you are updating the track's draft status. Otherwise, set the property value to id.
Returns
The caller should Execute the method instance, then destroy it when they are finished.

◆ NewUpdateMethod() [2/2]

CaptionsResource_UpdateMethod * google_youtube_api::YouTubeService::CaptionsResource::NewUpdateMethod ( client::AuthorizationCredential *  _credential_,
const absl::string_view &  part,
const Caption _metadata_,
const StringPiece &  _media_content_type_,
client::DataReader *  _media_content_reader_ 
) const

Creates a new CaptionsResource_UpdateMethod instance.

Parameters
[in]<em>credential</em>Can be NULL. NULL credentials will not authorize the request.
[in]partThe part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response will include. Set the property value to snippet if you are updating the track's draft status. Otherwise, set the property value to id.
[in]<em>metadata</em>The metadata object to update. If this is NULL then do not upload any metadata.
[in]<em>media_content_type</em>The content type of the data in the media_content_reader.
[in]<em>media_content_reader</em>The media content to update. If this is NULL then do not upload any media and ignore media_content_type.
Returns
The caller should Execute the method instance, then destroy it when they are finished.

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