Class: Yt::Models::Status

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

Overview

Contains information about the status of a resource. The details of the status are different for the different types of resources.

Resources with a status are: channels, playlists, playlist items and videos.

See Also:

Constant Summary collapse

PRIVACY_STATUSES =

Privacy status

%q(private public unlisted)

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Associations::HasReports

#has_report

Methods included from Associations::HasViewerPercentages

#has_viewer_percentages

Methods included from Associations::HasOne

#has_one

Methods included from Associations::HasMany

#has_many

Methods included from Associations::HasAuthentication

#has_authentication

Constructor Details

#initialize(options = {}) ⇒ Status

Returns a new instance of Status.



17
18
19
 
# File 'lib/yt/models/status.rb', line 17

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

Instance Attribute Details

#data ⇒ Object (readonly)

Returns the value of attribute data.



15
16
17
 
# File 'lib/yt/models/status.rb', line 15

def data
  @data
end

Instance Method Details

#aborted? ⇒ Boolean?

Returns whether a video upload failed because the upload was aborted.

Returns:

  • (Boolean) —

    if the resource is a video, whether the uploading process was aborted.

  • (nil) —

    if the resource is not a video or upload has not failed.



150
151
152
 
# File 'lib/yt/models/status.rb', line 150

def aborted?
  failure_reason == 'uploadAborted' if video?
end

#belongs_to_closed_account? ⇒ Boolean?

Returns whether a video was rejected because the account was closed.

Returns:

  • (Boolean) —

    if the resource is a rejected video, whether the account associated with the video has been closed.

  • (nil) —

    if the resource is not a rejected video.



226
227
228
 
# File 'lib/yt/models/status.rb', line 226

def belongs_to_closed_account?
  rejection_reason == 'uploaderAccountClosed' if video?
end

#belongs_to_suspended_account? ⇒ Boolean?

Returns whether a video was rejected because the account was suspended.

Returns:

  • (Boolean) —

    if the resource is a rejected video, whether the account associated with the video has been suspended.

  • (nil) —

    if the resource is not a rejected video.



234
235
236
 
# File 'lib/yt/models/status.rb', line 234

def belongs_to_suspended_account?
  rejection_reason == 'uploaderAccountSuspended' if video?
end

#claimed? ⇒ Boolean?

Returns whether a video was rejected because it was claimed.

Returns:

  • (Boolean) —

    if the resource is a rejected video, whether the video was claimed by a different account.

  • (nil) —

    if the resource is not a rejected video.



168
169
170
 
# File 'lib/yt/models/status.rb', line 168

def claimed?
  rejection_reason == 'claim' if video?
end

#deleted? ⇒ Boolean?

Returns whether an uploaded video was deleted.

Returns:

  • (Boolean) —

    if the resource is a video, whether the uploaded video was deleted by the user.

  • (nil) —

    if the resource is not a video.



57
58
59
 
# File 'lib/yt/models/status.rb', line 57

def deleted?
  upload_status == 'deleted' if video?
end

#duplicate? ⇒ Boolean?

Returns whether a video was rejected because it is a duplicate.

Returns:

  • (Boolean) —

    if the resource is a rejected video, whether the video is a duplicate of another uploaded video.

  • (nil) —

    if the resource is not a rejected video.



184
185
186
 
# File 'lib/yt/models/status.rb', line 184

def duplicate?
  rejection_reason == 'duplicate' if video?
end

#embeddable ⇒ Object

Deprecated.

Use #embeddable? instead.



292
293
294
 
# File 'lib/yt/models/status.rb', line 292

def embeddable
  embeddable?
end

#embeddable? ⇒ Boolean?

Returns whether the video can be embedded on another website.

Returns:

  • (Boolean) —

    if the resource is a video, whether it can be embedded on another website.

  • (nil) —

    if the resource is not a video.



289
 
# File 'lib/yt/models/status.rb', line 289

has_attribute :embeddable?, from: :embeddable

#empty? ⇒ Boolean?

Returns whether a video upload failed because the file was empty.

Returns:

  • (Boolean) —

    if the resource is a video, whether the video file is empty.

  • (nil) —

    if the resource is not a video or upload has not failed.



125
126
127
 
# File 'lib/yt/models/status.rb', line 125

def empty?
  failure_reason == 'emptyFile' if video?
end

#failed? ⇒ Boolean?

Returns whether a video failed to upload. If true, the reason why the video upload failed can be obtained with failure_reason.

Returns:

  • (Boolean) —

    if the resource is a video, whether the video failed to upload.

  • (nil) —

    if the resource is not a video.



66
67
68
 
# File 'lib/yt/models/status.rb', line 66

def failed?
  upload_status == 'failed' if video?
end

#failure_reason ⇒ String?

Returns the reason why a video failed to upload.

Returns:

  • (String) —

    if resource is a video with a ‘failed’ upload status, the reason why the video failed to upload. Valid values are: codec, conversion, emptyFile, invalidFile, tooSmall, uploadAborted.

  • (nil) —

    if the resource is not a video or upload has not failed.



102
 
# File 'lib/yt/models/status.rb', line 102

has_attribute :failure_reason

#has_failed_conversion? ⇒ Boolean?

Returns whether YouTube was unable to convert an uploaded video.

Returns:

  • (Boolean) —

    if the resource is a video, whether YouTube was unable to convert the video.

  • (nil) —

    if the resource is not a video or upload has not failed.



117
118
119
 
# File 'lib/yt/models/status.rb', line 117

def has_failed_conversion?
  failure_reason == 'conversion' if video?
end

#has_public_stats_viewable? ⇒ Boolean?

Returns whether the video statistics are publicly viewable.

Returns:

  • (Boolean) —

    if the resource is a video, whether the extended video statistics on the video’s watch page are publicly viewable. By default, those statistics are viewable, and statistics like a video’s viewcount and ratings will still be publicly visible even if this property’s value is set to false.

  • (nil) —

    if the resource is not a video.



305
 
# File 'lib/yt/models/status.rb', line 305

has_attribute :has_public_stats_viewable?, from: :public_stats_viewable

#inappropriate? ⇒ Boolean?

Returns whether a video was rejected because of inappropriate content.

Returns:

  • (Boolean) —

    if the resource is a rejected video, whether the video contains inappropriate content.

  • (nil) —

    if the resource is not a rejected video.



192
193
194
 
# File 'lib/yt/models/status.rb', line 192

def inappropriate?
  rejection_reason == 'inappropriate' if video?
end

#infringes_copyright? ⇒ Boolean?

Returns whether a video was rejected because of copyright infringement.

Returns:

  • (Boolean) —

    if the resource is a rejected video, whether the video commits a copyright infringement.

  • (nil) —

    if the resource is not a rejected video.



176
177
178
 
# File 'lib/yt/models/status.rb', line 176

def infringes_copyright?
  rejection_reason == 'copyright' if video?
end

#infringes_trademark? ⇒ Boolean?

Returns whether a video was rejected because of trademark infringement.

Returns:

  • (Boolean) —

    if the resource is a rejected video, whether the video commits a trademark infringement.

  • (nil) —

    if the resource is not a rejected video.

See Also:



218
219
220
 
# File 'lib/yt/models/status.rb', line 218

def infringes_trademark?
  rejection_reason == 'trademark' if video?
end

#invalid? ⇒ Boolean?

Returns whether a video upload failed because of the file format.

Returns:

  • (Boolean) —

    if the resource is a video, whether the video uses a file format not supported by YouTube.

  • (nil) —

    if the resource is not a video or upload has not failed.

See Also:



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

def invalid?
  failure_reason == 'invalidFile' if video?
end

#license ⇒ String?

Returns the video’s license.

Returns:

  • (String) —

    if resource is a video, its license. Valid values are: creativeCommon, youtube.

  • (nil) —

    if the resource is not a video.



263
 
# File 'lib/yt/models/status.rb', line 263

has_attribute :license

#licensed_as_creative_commons? ⇒ Boolean?

Returns whether the video uses a Creative Commons license.

Returns:

  • (Boolean) —

    if the resource is a video, whether it uses a Creative Commons license.

  • (nil) —

    if the resource is not a video.

See Also:



270
271
272
 
# File 'lib/yt/models/status.rb', line 270

def licensed_as_creative_commons?
  license == 'creativeCommon' if video?
end

#licensed_as_standard_youtube? ⇒ Boolean?

Returns whether the video uses the Standard YouTube license.

Returns:

  • (Boolean) —

    if the resource is a video, whether it uses the Standard YouTube license.

  • (nil) —

    if the resource is not a video.

See Also:



279
280
281
 
# File 'lib/yt/models/status.rb', line 279

def licensed_as_standard_youtube?
  license == 'youtube' if video?
end

#privacy_status ⇒ String

Returns the privacy status of the resource. Valid values are: private, public, unlisted.

Returns:

  • (String) —

    the privacy status of the resource. Valid values are: private, public, unlisted.



27
 
# File 'lib/yt/models/status.rb', line 27

has_attribute :privacy_status

#private? ⇒ Boolean

Returns whether the resource is private.

Returns:

  • (Boolean) —

    whether the resource is private.



35
36
37
 
# File 'lib/yt/models/status.rb', line 35

def private?
  privacy_status == 'private'
end

#processed? ⇒ Boolean?

Returns whether an uploaded video is being processed by YouTube.

Returns:

  • (Boolean) —

    if the resource is a video, whether the uploaded video is being processed by YouTube.

  • (nil) —

    if the resource is not a video.



74
75
76
 
# File 'lib/yt/models/status.rb', line 74

def processed?
  upload_status == 'processed' if video?
end

#public? ⇒ Boolean

Returns whether the resource is public.

Returns:

  • (Boolean) —

    whether the resource is public.



30
31
32
 
# File 'lib/yt/models/status.rb', line 30

def public?
  privacy_status == 'public'
end

#public_stats_viewable ⇒ Object

Deprecated.

Use #has_public_stats_viewable? instead.



308
309
310
 
# File 'lib/yt/models/status.rb', line 308

def public_stats_viewable
  has_public_stats_viewable?
end

#rejected? ⇒ Boolean?

Returns whether the video was rejected by YouTube. If true, the reason why the video was rejected can be obtained with rejection_reason.

Returns:

  • (Boolean) —

    if the resource is a video, whether the video was rejected by YouTube.

  • (nil) —

    if the resource is not a video.



83
84
85
 
# File 'lib/yt/models/status.rb', line 83

def rejected?
  upload_status == 'rejected' if video?
end

#rejection_reason ⇒ String?

Returns the reason why a video was rejected by YouTube.

Returns:

  • (String) —

    if resource is a video with a ‘rejected’ upload status, the reason why the video was rejected. Valid values are: claim, copyright, duplicate, inappropriate, length, termsOfUse, trademark, uploaderAccountClosed, uploaderAccountSuspended.

  • (nil) —

    if the resource is not a rejected video.



162
 
# File 'lib/yt/models/status.rb', line 162

has_attribute :rejection_reason

#scheduled? ⇒ Boolean?

Returns whether the video is scheduled to be published.

Returns:

  • (Boolean) —

    if the resource is a video, whether it is currently private and is scheduled to become public in the future.

  • (nil) —

    if the resource is not a video.



253
254
255
 
# File 'lib/yt/models/status.rb', line 253

def scheduled?
  private? && publish_at if video?
end

#scheduled_at ⇒ Time?

Returns the date and time when a video is scheduled to be published.

Returns:

  • (Time) —

    if resource is a private video scheduled to be published, the date and time when the video is scheduled to publish.

  • (nil) —

    if the resource is not a private video scheduled to be published.



245
246
247
 
# File 'lib/yt/models/status.rb', line 245

def scheduled_at
  publish_at if scheduled?
end

#too_long? ⇒ Boolean?

Returns whether a video was rejected because it is too long.

Returns:

  • (Boolean) —

    if the resource is a rejected video, whether the video exceeds the maximum duration.

  • (nil) —

    if the resource is not a rejected video.

See Also:



201
202
203
 
# File 'lib/yt/models/status.rb', line 201

def too_long?
  rejection_reason == 'length' if video?
end

#too_small? ⇒ Boolean?

Returns whether a video upload failed because the file was too small.

Returns:

  • (Boolean) —

    if the resource is a video, whether the video file is too small for YouTube.

  • (nil) —

    if the resource is not a video or upload has not failed.



142
143
144
 
# File 'lib/yt/models/status.rb', line 142

def too_small?
  failure_reason == 'tooSmall' if video?
end

#unlisted? ⇒ Boolean

Returns whether the resource is unlisted.

Returns:

  • (Boolean) —

    whether the resource is unlisted.



40
41
42
 
# File 'lib/yt/models/status.rb', line 40

def unlisted?
  privacy_status == 'unlisted'
end

#upload_status ⇒ String?

Returns the upload status of a video.

Returns:

  • (String) —

    if the resource is a video, the status of the uploaded video. Valid values are: deleted, failed, processed, rejected, uploaded.

  • (nil) —

    if the resource is not a video.



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

has_attribute :upload_status

#uploaded? ⇒ Boolean?

Returns whether a video was successfully uploaded to YouTube.

Returns:

  • (Boolean) —

    if the resource is a video, whether the video was successfully uploaded.

  • (nil) —

    if the resource is not a video.



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

def uploaded?
  upload_status == 'uploaded' if video?
end

#uses_unsupported_codec? ⇒ Boolean?

Returns whether a video upload failed because of the codec.

Returns:

  • (Boolean) —

    if the resource is a video, whether the video uses a codec not supported by YouTube.

  • (nil) —

    if the resource is not a video or upload has not failed.

See Also:



109
110
111
 
# File 'lib/yt/models/status.rb', line 109

def uses_unsupported_codec?
  failure_reason == 'codec' if video?
end

#violates_terms_of_use? ⇒ Boolean?

Returns whether a video was rejected because it violates terms of use.

Returns:

  • (Boolean) —

    if the resource is a rejected video, whether the video commits a terms of use violation.

  • (nil) —

    if the resource is not a rejected video.



209
210
211
 
# File 'lib/yt/models/status.rb', line 209

def violates_terms_of_use?
  rejection_reason == 'termsOfUse' if video?
end