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

#include <you_tube_service.h>

Public Member Functions

 VideosResource (YouTubeService *service)
 
 ~VideosResource ()
 
VideosResource_DeleteMethodNewDeleteMethod (client::AuthorizationCredential *_credential_, const absl::string_view &id) const
 
VideosResource_GetRatingMethodNewGetRatingMethod (client::AuthorizationCredential *_credential_, const absl::string_view &id) const
 
VideosResource_InsertMethodNewInsertMethod (client::AuthorizationCredential *_credential_, const absl::string_view &part) const
 
VideosResource_InsertMethodNewInsertMethod (client::AuthorizationCredential *_credential_, const absl::string_view &part, const Video *_metadata_, const StringPiece &_media_content_type_, client::DataReader *_media_content_reader_) const
 
VideosResource_ListMethodNewListMethod (client::AuthorizationCredential *_credential_, const absl::string_view &part) const
 
VideosResource_ListMethodPager * NewListMethodPager (client::AuthorizationCredential *_credential_, const absl::string_view &part) const
 
VideosResource_RateMethodNewRateMethod (client::AuthorizationCredential *_credential_, const absl::string_view &id, const absl::string_view &rating) const
 
VideosResource_ReportAbuseMethodNewReportAbuseMethod (client::AuthorizationCredential *_credential_, const VideoAbuseReport &_content_) const
 
VideosResource_UpdateMethodNewUpdateMethod (client::AuthorizationCredential *_credential_, const absl::string_view &part, const Video &_content_) const
 

Detailed Description

Acts as message factory for accessing data.

Constructor & Destructor Documentation

◆ VideosResource()

google_youtube_api::YouTubeService::VideosResource::VideosResource ( 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.

◆ ~VideosResource()

google_youtube_api::YouTubeService::VideosResource::~VideosResource ( )
inline

Standard destructor.

Member Function Documentation

◆ NewDeleteMethod()

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

Creates a new VideosResource_DeleteMethod instance.

Parameters
[in]<em>credential</em>Can be NULL. NULL credentials will not authorize the request.
[in]idThe id parameter specifies the YouTube video ID for the resource that is being deleted. In a video resource, the id property specifies the video's ID.
Returns
The caller should Execute the method instance, then destroy it when they are finished.

◆ NewGetRatingMethod()

VideosResource_GetRatingMethod * google_youtube_api::YouTubeService::VideosResource::NewGetRatingMethod ( client::AuthorizationCredential *  _credential_,
const absl::string_view &  id 
) const

Creates a new VideosResource_GetRatingMethod instance.

Parameters
[in]<em>credential</em>Can be NULL. NULL credentials will not authorize the request.
[in]idThe id parameter specifies a comma-separated list of the YouTube video ID(s) for the resource(s) for which you are retrieving rating data. In a video resource, the id property specifies the video's ID.
Returns
The caller should Execute the method instance, then destroy it when they are finished.

◆ NewInsertMethod() [1/2]

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

Creates a new VideosResource_InsertMethod 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.

Note that not all parts contain properties that can be set when inserting or updating a video. For example, the statistics object encapsulates statistics that YouTube calculates for a video and does not contain values that you can set or modify. If the parameter value specifies a part that does not contain mutable values, that part will still be included in the API response.

Returns
The caller should Execute the method instance, then destroy it when they are finished.

◆ NewInsertMethod() [2/2]

VideosResource_InsertMethod * google_youtube_api::YouTubeService::VideosResource::NewInsertMethod ( client::AuthorizationCredential *  _credential_,
const absl::string_view &  part,
const Video _metadata_,
const StringPiece &  _media_content_type_,
client::DataReader *  _media_content_reader_ 
) const

Creates a new VideosResource_InsertMethod 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.

Note that not all parts contain properties that can be set when inserting or updating a video. For example, the statistics object encapsulates statistics that YouTube calculates for a video and does not contain values that you can set or modify. If the parameter value specifies a part that does not contain mutable values, that part will still be included in the API response.

Parameters
[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()

VideosResource_ListMethod * google_youtube_api::YouTubeService::VideosResource::NewListMethod ( client::AuthorizationCredential *  _credential_,
const absl::string_view &  part 
) const

Creates a new VideosResource_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 video resource properties that the API response will include.

If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a video resource, the snippet property contains the channelId, title, description, tags, and categoryId properties. As such, if you set part=snippet, the API response will contain all of those properties.

Returns
The caller should Execute the method instance, then destroy it when they are finished.

◆ NewListMethodPager()

VideosResource_ListMethodPager * google_youtube_api::YouTubeService::VideosResource::NewListMethodPager ( client::AuthorizationCredential *  _credential_,
const absl::string_view &  part 
) const

Creates a pager for iterating over incremental result pages.

Parameters
[in]<em>credential</em>NULL credentials will not authorize the request.
[in]partThe part parameter specifies a comma-separated list of one or more video resource properties that the API response will include.

If the parameter identifies a property that contains child properties, the child properties will be included in the response. For example, in a video resource, the snippet property contains the channelId, title, description, tags, and categoryId properties. As such, if you set part=snippet, the API response will contain all of those properties.

See also
googleapis::googleapis::ServiceRequestPager

◆ NewRateMethod()

VideosResource_RateMethod * google_youtube_api::YouTubeService::VideosResource::NewRateMethod ( client::AuthorizationCredential *  _credential_,
const absl::string_view &  id,
const absl::string_view &  rating 
) const

Creates a new VideosResource_RateMethod instance.

Parameters
[in]<em>credential</em>Can be NULL. NULL credentials will not authorize the request.
[in]idThe id parameter specifies the YouTube video ID of the video that is being rated or having its rating removed.
[in]ratingSpecifies the rating to record.
Returns
The caller should Execute the method instance, then destroy it when they are finished.

◆ NewReportAbuseMethod()

VideosResource_ReportAbuseMethod * google_youtube_api::YouTubeService::VideosResource::NewReportAbuseMethod ( client::AuthorizationCredential *  _credential_,
const VideoAbuseReport _content_ 
) const

Creates a new VideosResource_ReportAbuseMethod instance.

Parameters
[in]<em>credential</em>Can be NULL. NULL credentials will not authorize the request.
[in]<em>content</em>The data object to reportAbuse.
Returns
The caller should Execute the method instance, then destroy it when they are finished.

◆ NewUpdateMethod()

VideosResource_UpdateMethod * google_youtube_api::YouTubeService::VideosResource::NewUpdateMethod ( client::AuthorizationCredential *  _credential_,
const absl::string_view &  part,
const Video _content_ 
) const

Creates a new VideosResource_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.

Note that this method will override the existing values for all of the mutable properties that are contained in any parts that the parameter value specifies. For example, a video's privacy setting is contained in the status part. As such, if your request is updating a private video, and the request's part parameter value includes the status part, the video's privacy setting will be updated to whatever value the request body specifies. If the request body does not specify a value, the existing privacy setting will be removed and the video will revert to the default privacy setting.

In addition, not all parts contain properties that can be set when inserting or updating a video. For example, the statistics object encapsulates statistics that YouTube calculates for a video and does not contain values that you can set or modify. If the parameter value specifies a part that does not contain mutable values, that part will still be included in the API response.

Parameters
[in]<em>content</em>The data object to update.
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: