Class: Yt::Models::Video

Inherits:

Resource

• Object
• Base
• Resource
• Yt::Models::Video

Defined in:

lib/yt/models/video.rb

Overview

Provides methods to interact with YouTube videos.

See Also:

• https://developers.google.com/youtube/v3/docs/videos

Instance Attribute Summary

• #annotations ⇒ Yt::Collections::Annotations readonly

  The video’s annotations.

• #details_set ⇒ Yt::Models::DetailsSet readonly

  The video’s content details.

• #rating ⇒ Yt::Models::Rating readonly

  The video’s rating.

Attributes inherited from Resource

#auth

Instance Method Summary

• #dislike ⇒ Boolean

  Dislikes the video on behalf of the authenticated account.

• #like ⇒ Boolean

  Likes the video on behalf of the authenticated account.

• #liked? ⇒ Boolean

  Returns whether the authenticated account likes the video.

• #unlike ⇒ Boolean

  Resets the rating of the video on behalf of the authenticated account.

Methods inherited from Resource

#initialize, #kind, #username

Constructor Details

This class inherits a constructor from Yt::Models::Resource

Instance Attribute Details

#annotations ⇒ Yt::Collections::Annotations (readonly)

Returns the video’s annotations.

Returns:

• (Yt::Collections::Annotations) —

  the video’s annotations.

# File 'lib/yt/models/video.rb', line 19

has_many :annotations

#details_set ⇒ Yt::Models::DetailsSet (readonly)

Returns the video’s content details.

Returns:

• (Yt::Models::DetailsSet) —

  the video’s content details.

# File 'lib/yt/models/video.rb', line 10

has_one :details_set

#rating ⇒ Yt::Models::Rating (readonly)

Returns the video’s rating.

Returns:

• (Yt::Models::Rating) —

  the video’s rating.

# File 'lib/yt/models/video.rb', line 15

has_one :rating

Instance Method Details

#dislike ⇒ Boolean

Dislikes the video on behalf of the authenticated account.

This method requires auth to return an authenticated instance of Account.

Returns:

• (Boolean) —

  whether the account does not like the video.

Raises:

• (Yt::Errors::Unauthorized) —

  if auth does not return an authenticated account.

# File 'lib/yt/models/video.rb', line 51

def dislike
  rating.update :dislike
  !liked?
end

#like ⇒ Boolean

Likes the video on behalf of the authenticated account.

This method requires auth to return an authenticated instance of Account.

Returns:

• (Boolean) —

  whether the account likes the video.

Raises:

• (Yt::Errors::Unauthorized) —

  if auth does not return an authenticated account.

# File 'lib/yt/models/video.rb', line 39

def like
  rating.update :like
  liked?
end

#liked? ⇒ Boolean

Returns whether the authenticated account likes the video.

This method requires auth to return an authenticated instance of Account.

Returns:

• (Boolean) —

  whether the account likes the video.

Raises:

• (Yt::Errors::Unauthorized) —

  if auth does not return an authenticated account.

# File 'lib/yt/models/video.rb', line 28

def liked?
  rating.rating == :like
end

#unlike ⇒ Boolean

Resets the rating of the video on behalf of the authenticated account.

This method requires auth to return an authenticated instance of Account.

Returns:

• (Boolean) —

  whether the account does not like the video.

Raises:

• (Yt::Errors::Unauthorized) —

  if auth does not return an authenticated account.

# File 'lib/yt/models/video.rb', line 63

def unlike
  rating.update :none
  !liked?
end