GoogleApi.YouTube.V3.Model.CommentSnippet (google_api_you_tube v0.54.0)

View Source

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

Attributes

  • authorChannelId (type: GoogleApi.YouTube.V3.Model.CommentSnippetAuthorChannelId.t, default: nil) -
  • authorChannelUrl (type: String.t, default: nil) - Link to the author's YouTube channel, if any.
  • authorDisplayName (type: String.t, default: nil) - The name of the user who posted the comment.
  • authorProfileImageUrl (type: String.t, default: nil) - The URL for the avatar of the user who posted the comment.
  • canRate (type: boolean(), default: nil) - Whether the current viewer can rate this comment.
  • channelId (type: String.t, default: nil) - 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.
  • likeCount (type: integer(), default: nil) - The total number of likes this comment has received.
  • moderationStatus (type: String.t, default: nil) - The comment's moderation status. Will not be set if the comments were requested through the id filter.
  • parentId (type: String.t, default: nil) - The unique id of the top-level comment, only set for replies.
  • postId (type: String.t, default: nil) - The ID of the post the comment refers to, if any.
  • publishedAt (type: DateTime.t, default: nil) - The date and time when the comment was originally published.
  • textDisplay (type: String.t, default: nil) - 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.
  • textOriginal (type: String.t, default: nil) - 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.
  • updatedAt (type: DateTime.t, default: nil) - The date and time when the comment was last updated.
  • videoId (type: String.t, default: nil) - The ID of the video the comment refers to, if any.
  • viewerRating (type: String.t, default: nil) - 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.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.YouTube.V3.Model.CommentSnippet{
  authorChannelId:
    GoogleApi.YouTube.V3.Model.CommentSnippetAuthorChannelId.t() | nil,
  authorChannelUrl: String.t() | nil,
  authorDisplayName: String.t() | nil,
  authorProfileImageUrl: String.t() | nil,
  canRate: boolean() | nil,
  channelId: String.t() | nil,
  likeCount: integer() | nil,
  moderationStatus: String.t() | nil,
  parentId: String.t() | nil,
  postId: String.t() | nil,
  publishedAt: DateTime.t() | nil,
  textDisplay: String.t() | nil,
  textOriginal: String.t() | nil,
  updatedAt: DateTime.t() | nil,
  videoId: String.t() | nil,
  viewerRating: String.t() | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.