Class: Yt::Models::Reference

Inherits:
Base
  • Object
show all
Defined in:
lib/yt/models/reference.rb

Overview

Provides methods to interact with YouTube ContentID references.

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Reference


8
9
10
11
12
# File 'lib/yt/models/reference.rb', line 8

def initialize(options = {})
  @data = options[:data]
  @id = options[:id]
  @auth = options[:auth]
end

Instance Method Details

#activating?Boolean


91
92
93
# File 'lib/yt/models/reference.rb', line 91

def activating?
  status == 'activating'
end

#active?Boolean


96
97
98
# File 'lib/yt/models/reference.rb', line 96

def active?
  status == 'active'
end

#asset_idString


33
# File 'lib/yt/models/reference.rb', line 33

has_attribute :asset_id

#audio?Boolean


146
147
148
# File 'lib/yt/models/reference.rb', line 146

def audio?
  content_type == 'audio'
end

#audioswap_enabled?boolean


55
# File 'lib/yt/models/reference.rb', line 55

has_attribute :audioswap_enabled?, from: :audioswap_enabled

#audiovisual?Boolean


156
157
158
# File 'lib/yt/models/reference.rb', line 156

def audiovisual?
  content_type == 'audiovisual'
end

#checking?Boolean


102
103
104
# File 'lib/yt/models/reference.rb', line 102

def checking?
  status == 'checking'
end

#claim_idString


49
# File 'lib/yt/models/reference.rb', line 49

has_attribute :claim_id

#computing_fingerprint?Boolean


108
109
110
# File 'lib/yt/models/reference.rb', line 108

def computing_fingerprint?
  status == 'computing_fingerprint'
end

#content_typeString

Returns the audiovisual portion of the referenced content.


143
# File 'lib/yt/models/reference.rb', line 143

has_attribute :content_type

#deleteBoolean

Note:

YouTube API does not provide a delete method for the Reference resource, but only an update method. Updating the status of a Reference to “inactive” can be considered a soft-deletion, since it allows to successively create new references for the same claim.

Soft-deletes the reference.


21
22
23
24
25
# File 'lib/yt/models/reference.rb', line 21

def delete
  body = {id: id, status: :inactive}
  do_update(body: body) {|data| @data = data}
  inactive?
end

#deleted?Boolean


113
114
115
# File 'lib/yt/models/reference.rb', line 113

def deleted?
  status == 'deleted'
end

#duplicate_leaderString


80
# File 'lib/yt/models/reference.rb', line 80

has_attribute :duplicate_leader

#duplicate_on_hold?Boolean


118
119
120
# File 'lib/yt/models/reference.rb', line 118

def duplicate_on_hold?
  status == 'duplicate_on_hold'
end

#idString


29
# File 'lib/yt/models/reference.rb', line 29

has_attribute :id

#ignore_fp_match?boolean


60
# File 'lib/yt/models/reference.rb', line 60

has_attribute :ignore_fp_match?, from: :ignore_fp_match

#inactive?Boolean


123
124
125
# File 'lib/yt/models/reference.rb', line 123

def inactive?
  status == 'inactive'
end

#lengthFloat


36
# File 'lib/yt/models/reference.rb', line 36

has_attribute :length

#live_streaming_processing?Boolean


129
130
131
# File 'lib/yt/models/reference.rb', line 129

def live_streaming_processing?
  status == 'live_streaming_processing'
end

#statusString


88
# File 'lib/yt/models/reference.rb', line 88

has_attribute :status

#status_reasonString


75
# File 'lib/yt/models/reference.rb', line 75

has_attribute :status_reason

#urgent?Boolean


70
# File 'lib/yt/models/reference.rb', line 70

has_attribute :urgent?, from: :urgent

#urgent_reference_processing?Boolean


134
135
136
# File 'lib/yt/models/reference.rb', line 134

def urgent_reference_processing?
  status == 'urgent_reference_processing'
end

#video?Boolean


151
152
153
# File 'lib/yt/models/reference.rb', line 151

def video?
  content_type == 'video'
end

#video_idString


42
# File 'lib/yt/models/reference.rb', line 42

has_attribute :video_id