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.



2081
2082
2083
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 2081

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) 


1996
1997
1998
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 1996

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) 


2001
2002
2003
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 2001

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) 


2006
2007
2008
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 2006

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) 


2011
2012
2013
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 2011

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) 


2016
2017
2018
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 2016

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) 


2024
2025
2026
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 2024

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) 


2029
2030
2031
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 2029

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) 


2035
2036
2037
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 2035

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) 


2040
2041
2042
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 2040

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) 


2046
2047
2048
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 2046

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) 


2054
2055
2056
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 2054

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) 


2061
2062
2063
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 2061

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) 


2067
2068
2069
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 2067

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) 


2072
2073
2074
 
# File 'generated/google/apis/youtube_v3/classes.rb', line 2072

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) 


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

def viewer_rating
  @viewer_rating
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



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

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