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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/youtube_v3/classes.rb,
generated/google/apis/youtube_v3/representations.rb,
generated/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

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ CommentSnippet

Returns a new instance of CommentSnippet



2078
2079
2080
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 2078

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

Instance Attribute Details

#author_channel_id ⇒ Object

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

Returns:

  • (Object) 


1993
1994
1995
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 1993

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) 


1998
1999
2000
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 1998

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) 


2003
2004
2005
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 2003

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) 


2008
2009
2010
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 2008

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) 


2013
2014
2015
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 2013

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 comment it's the video's channel. Corresponds to the JSON property channelId

Returns:

  • (String) 


2021
2022
2023
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 2021

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) 


2026
2027
2028
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 2026

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) 


2032
2033
2034
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 2032

def moderation_status
  @moderation_status
end

#parent_id ⇒ String

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

Returns:

  • (String) 


2037
2038
2039
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 2037

def parent_id
  @parent_id
end

#published_at ⇒ DateTime

The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. Corresponds to the JSON property publishedAt

Returns:

  • (DateTime) 


2043
2044
2045
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 2043

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) 


2051
2052
2053
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 2051

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) 


2058
2059
2060
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 2058

def text_original
  @text_original
end

#updated_at ⇒ DateTime

The date and time when was last updated . The value is specified in ISO 8601 ( YYYY-MM-DDThh:mm:ss.sZ) format. Corresponds to the JSON property updatedAt

Returns:

  • (DateTime) 


2064
2065
2066
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 2064

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) 


2069
2070
2071
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 2069

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) 


2076
2077
2078
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 2076

def viewer_rating
  @viewer_rating
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 2083

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)
  @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