google_api_you_tube

v0.4.0

google_api_you_tube v0.4.0 GoogleApi.YouTube.V3.Model.CommentSnippet View Source

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

Attributes

  • authorChannelId (String.t): The id of the author's YouTube channel, if any. Defaults to: null.
  • authorChannelUrl (String.t): Link to the author's YouTube channel, if any. Defaults to: null.
  • authorDisplayName (String.t): The name of the user who posted the comment. Defaults to: null.
  • authorProfileImageUrl (String.t): The URL for the avatar of the user who posted the comment. Defaults to: null.
  • canRate (boolean()): Whether the current viewer can rate this comment. Defaults to: null.
  • channelId (String.t): 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. Defaults to: null.
  • likeCount (integer()): The total number of likes this comment has received. Defaults to: null.

  • moderationStatus (String.t): The comment's moderation status. Will not be set if the comments were requested through the id filter. Defaults to: null.

    • Enum - one of [heldForReview, likelySpam, published, rejected]
  • parentId (String.t): The unique id of the parent comment, only set for replies. Defaults to: null.
  • publishedAt (DateTime.t): The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. Defaults to: null.
  • textDisplay (String.t): 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. Defaults to: null.
  • textOriginal (String.t): 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. Defaults to: null.
  • updatedAt (DateTime.t): The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format. Defaults to: null.
  • videoId (String.t): The ID of the video the comment refers to, if any. Defaults to: null.

  • viewerRating (String.t): 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. Defaults to: null.

    • Enum - one of [dislike, like, none, unspecified]

Link to this section Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Link to this type

t() View Source 
t() :: %GoogleApi.YouTube.V3.Model.CommentSnippet{
  authorChannelId: any(),
  authorChannelUrl: any(),
  authorDisplayName: any(),
  authorProfileImageUrl: any(),
  canRate: any(),
  channelId: any(),
  likeCount: any(),
  moderationStatus: any(),
  parentId: any(),
  publishedAt: DateTime.t(),
  textDisplay: any(),
  textOriginal: any(),
  updatedAt: DateTime.t(),
  videoId: any(),
  viewerRating: any()
}

Link to this section Functions

Link to this function

decode(value, options) View Source 
decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.