Class: Yt::Models::Claim
Overview
Provides methods to interact with YouTube ContentID claims.
Constant Summary collapse
- STATUSES =
Status
%q(active appealed disputed inactive pending potential takedown unknown)
- CONTENT_TYPES =
Content Type
%q(audio video audiovisual)
Instance Method Summary collapse
-
#active? ⇒ Boolean
Whether the claim is active.
-
#appealed? ⇒ Boolean
Whether the claim is appealed.
-
#asset_id ⇒ String
The unique YouTube asset ID that identifies the asset associated with the claim.
-
#audio? ⇒ Boolean
Whether the covers the audio of the content.
-
#audiovisual? ⇒ Boolean
Whether the covers the audiovisual of the content.
-
#block_outside_ownership? ⇒ Boolean
Return whether the video should be blocked where not explicitly owned.
-
#content_type ⇒ String
Whether the claim covers the audio, video, or audiovisual portion of the claimed content.
-
#created_at ⇒ Time
The date and time that the claim was created.
-
#delete ⇒ Boolean
Soft-deletes the claim.
-
#disputed? ⇒ Boolean
Whether the claim is disputed.
-
#has_unknown_status? ⇒ Boolean
Whether the claim status is unknown.
-
#id ⇒ String
The ID that YouTube assigns and uses to uniquely identify the claim.
-
#inactive? ⇒ Boolean
Whether the claim is inactive.
-
#initialize(options = {}) ⇒ Claim
constructor
A new instance of Claim.
-
#match_reference_id ⇒ String
The unique ID that YouTube uses to identify the reference that generated the match.
-
#pending? ⇒ Boolean
Whether the claim is pending.
-
#potential? ⇒ Boolean
Whether the claim is potential.
-
#status ⇒ String
The claim’s status.
-
#takedown? ⇒ Boolean
Whether the claim is takedown.
-
#third_party? ⇒ Boolean
Whether a third party created the claim.
-
#video? ⇒ Boolean
Whether the covers the video of the content.
-
#video_id ⇒ String
The unique YouTube video ID that identifies the video associated with the claim.
Methods included from Associations::HasReports
Methods included from Associations::HasViewerPercentages
Methods included from Associations::HasOne
Methods included from Associations::HasMany
Methods included from Associations::HasAuthentication
Constructor Details
#initialize(options = {}) ⇒ Claim
Returns a new instance of Claim.
8 9 10 11 12 |
# File 'lib/yt/models/claim.rb', line 8 def initialize( = {}) @data = [:data] @id = [:id] @auth = [:auth] end |
Instance Method Details
#active? ⇒ Boolean
Returns whether the claim is active.
50 51 52 |
# File 'lib/yt/models/claim.rb', line 50 def active? status == 'active' end |
#appealed? ⇒ Boolean
Returns whether the claim is appealed.
55 56 57 |
# File 'lib/yt/models/claim.rb', line 55 def appealed? status == 'appealed' end |
#asset_id ⇒ String
Returns the unique YouTube asset ID that identifies the asset associated with the claim.
31 |
# File 'lib/yt/models/claim.rb', line 31 has_attribute :asset_id |
#audio? ⇒ Boolean
Returns whether the covers the audio of the content.
99 100 101 |
# File 'lib/yt/models/claim.rb', line 99 def audio? content_type == 'audio' end |
#audiovisual? ⇒ Boolean
Returns whether the covers the audiovisual of the content.
109 110 111 |
# File 'lib/yt/models/claim.rb', line 109 def audiovisual? content_type == 'audiovisual' end |
#block_outside_ownership? ⇒ Boolean
Return whether the video should be blocked where not explicitly owned.
132 |
# File 'lib/yt/models/claim.rb', line 132 has_attribute :block_outside_ownership?, from: :block_outside_ownership |
#content_type ⇒ String
Returns whether the claim covers the audio, video, or audiovisual portion of the claimed content. Valid values are: audio, audiovisual, video.
96 |
# File 'lib/yt/models/claim.rb', line 96 has_attribute :content_type |
#created_at ⇒ Time
Returns the date and time that the claim was created.
114 |
# File 'lib/yt/models/claim.rb', line 114 has_attribute :created_at, type: Time, from: :time_created |
#delete ⇒ Boolean
YouTube API does not provide a delete
method for the Asset resource, but only an update
method. Updating the status
of a Asset to “inactive” can be considered a soft-deletion.
Soft-deletes the claim.
19 20 21 22 23 |
# File 'lib/yt/models/claim.rb', line 19 def delete body = {status: :inactive} do_patch(body: body) {|data| @data = data} inactive? end |
#disputed? ⇒ Boolean
Returns whether the claim is disputed.
60 61 62 |
# File 'lib/yt/models/claim.rb', line 60 def disputed? status == 'disputed' end |
#has_unknown_status? ⇒ Boolean
Returns whether the claim status is unknown.
85 86 87 |
# File 'lib/yt/models/claim.rb', line 85 def has_unknown_status? status == 'unknown' end |
#id ⇒ String
Returns the ID that YouTube assigns and uses to uniquely identify the claim.
27 |
# File 'lib/yt/models/claim.rb', line 27 has_attribute :id |
#inactive? ⇒ Boolean
Returns whether the claim is inactive.
65 66 67 |
# File 'lib/yt/models/claim.rb', line 65 def inactive? status == 'inactive' end |
#match_reference_id ⇒ String
Returns The unique ID that YouTube uses to identify the reference that generated the match.
136 137 138 |
# File 'lib/yt/models/claim.rb', line 136 has_attribute :match_reference_id, from: :match_info do |match_info| (match_info || {})['referenceId'] end |
#pending? ⇒ Boolean
Returns whether the claim is pending.
70 71 72 |
# File 'lib/yt/models/claim.rb', line 70 def pending? status == 'pending' end |
#potential? ⇒ Boolean
Returns whether the claim is potential.
75 76 77 |
# File 'lib/yt/models/claim.rb', line 75 def potential? status == 'potential' end |
#status ⇒ String
When updating a claim, you can update its status from active to inactive to effectively release the claim, but the API does not support other updates to a claim’s status.
Returns the claim’s status. Valid values are: active, appealed, disputed, inactive, pending, potential, takedown, unknown.
47 |
# File 'lib/yt/models/claim.rb', line 47 has_attribute :status |
#takedown? ⇒ Boolean
Returns whether the claim is takedown.
80 81 82 |
# File 'lib/yt/models/claim.rb', line 80 def takedown? status == 'takedown' end |
#third_party? ⇒ Boolean
Returns whether a third party created the claim.
117 118 119 |
# File 'lib/yt/models/claim.rb', line 117 has_attribute :third_party?, from: :third_party_claim do |value| value == true end |
#video? ⇒ Boolean
Returns whether the covers the video of the content.
104 105 106 |
# File 'lib/yt/models/claim.rb', line 104 def video? content_type == 'video' end |
#video_id ⇒ String
Returns the unique YouTube video ID that identifies the video associated with the claim.
35 |
# File 'lib/yt/models/claim.rb', line 35 has_attribute :video_id |