Class: Google::Apis::YoutubeV3::CommentSnippet

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/youtube_v3/classes.rb,
lib/google/apis/youtube_v3/representations.rb,
lib/google/apis/youtube_v3/representations.rb

Overview

Basic details about a comment, such as its author and text.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ CommentSnippet

Returns a new instance of CommentSnippet.



2425
2426
2427
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 2425

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#author_channel_id ⇒ Google::Apis::YoutubeV3::CommentSnippetAuthorChannelId

Contains the id of the author's YouTube channel, if any. Corresponds to the JSON property authorChannelId

Returns:



2337
2338
2339
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 2337

def author_channel_id
  @author_channel_id
end

#author_channel_url ⇒ String

Link to the author's YouTube channel, if any. Corresponds to the JSON property authorChannelUrl

Returns:

  • (String) 


2342
2343
2344
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 2342

def author_channel_url
  @author_channel_url
end

#author_display_name ⇒ String

The name of the user who posted the comment. Corresponds to the JSON property authorDisplayName

Returns:

  • (String) 


2347
2348
2349
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 2347

def author_display_name
  @author_display_name
end

#author_profile_image_url ⇒ String

The URL for the avatar of the user who posted the comment. Corresponds to the JSON property authorProfileImageUrl

Returns:

  • (String) 


2352
2353
2354
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 2352

def author_profile_image_url
  @author_profile_image_url
end

#can_rate ⇒ Boolean Also known as: can_rate?

Whether the current viewer can rate this comment. Corresponds to the JSON property canRate

Returns:

  • (Boolean) 


2357
2358
2359
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 2357

def can_rate
  @can_rate
end

#channel_id ⇒ String

The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video or post comment it's the video/post's channel. Corresponds to the JSON property channelId

Returns:

  • (String) 


2365
2366
2367
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 2365

def channel_id
  @channel_id
end

#like_count ⇒ Fixnum

The total number of likes this comment has received. Corresponds to the JSON property likeCount

Returns:

  • (Fixnum) 


2370
2371
2372
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 2370

def like_count
  @like_count
end

#moderation_status ⇒ String

The comment's moderation status. Will not be set if the comments were requested through the id filter. Corresponds to the JSON property moderationStatus

Returns:

  • (String) 


2376
2377
2378
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 2376

def moderation_status
  @moderation_status
end

#parent_id ⇒ String

The unique id of the top-level comment, only set for replies. Corresponds to the JSON property parentId

Returns:

  • (String) 


2381
2382
2383
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 2381

def parent_id
  @parent_id
end

#post_id ⇒ String

The ID of the post the comment refers to, if any. Corresponds to the JSON property postId

Returns:

  • (String) 


2386
2387
2388
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 2386

def post_id
  @post_id
end

#published_at ⇒ DateTime

The date and time when the comment was originally published. Corresponds to the JSON property publishedAt

Returns:

  • (DateTime) 


2391
2392
2393
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 2391

def published_at
  @published_at
end

#text_display ⇒ String

The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc. Corresponds to the JSON property textDisplay

Returns:

  • (String) 


2399
2400
2401
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 2399

def text_display
  @text_display
end

#text_original ⇒ String

The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author. Corresponds to the JSON property textOriginal

Returns:

  • (String) 


2406
2407
2408
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 2406

def text_original
  @text_original
end

#updated_at ⇒ DateTime

The date and time when the comment was last updated. Corresponds to the JSON property updatedAt

Returns:

  • (DateTime) 


2411
2412
2413
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 2411

def updated_at
  @updated_at
end

#video_id ⇒ String

The ID of the video the comment refers to, if any. Corresponds to the JSON property videoId

Returns:

  • (String) 


2416
2417
2418
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 2416

def video_id
  @video_id
end

#viewer_rating ⇒ String

The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future. Corresponds to the JSON property viewerRating

Returns:

  • (String) 


2423
2424
2425
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 2423

def viewer_rating
  @viewer_rating
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
 
# File 'lib/google/apis/youtube_v3/classes.rb', line 2430

def update!(**args)
  @author_channel_id = args[:author_channel_id] if args.key?(:author_channel_id)
  @author_channel_url = args[:author_channel_url] if args.key?(:author_channel_url)
  @author_display_name = args[:author_display_name] if args.key?(:author_display_name)
  @author_profile_image_url = args[:author_profile_image_url] if args.key?(:author_profile_image_url)
  @can_rate = args[:can_rate] if args.key?(:can_rate)
  @channel_id = args[:channel_id] if args.key?(:channel_id)
  @like_count = args[:like_count] if args.key?(:like_count)
  @moderation_status = args[:moderation_status] if args.key?(:moderation_status)
  @parent_id = args[:parent_id] if args.key?(:parent_id)
  @post_id = args[:post_id] if args.key?(:post_id)
  @published_at = args[:published_at] if args.key?(:published_at)
  @text_display = args[:text_display] if args.key?(:text_display)
  @text_original = args[:text_original] if args.key?(:text_original)
  @updated_at = args[:updated_at] if args.key?(:updated_at)
  @video_id = args[:video_id] if args.key?(:video_id)
  @viewer_rating = args[:viewer_rating] if args.key?(:viewer_rating)
end