View Source GoogleApi.Books.V1.Model.Annotation (google_api_books v0.21.0)

Attributes

afterSelectedText (type: String.t, default: nil) - Anchor text after excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
beforeSelectedText (type: String.t, default: nil) - Anchor text before excerpt. For requests, if the user bookmarked a screen that has no flowing text on it, then this field should be empty.
clientVersionRanges (type: GoogleApi.Books.V1.Model.AnnotationClientVersionRanges.t, default: nil) - Selection ranges sent from the client.
created (type: String.t, default: nil) - Timestamp for the created time of this annotation.
currentVersionRanges (type: GoogleApi.Books.V1.Model.AnnotationCurrentVersionRanges.t, default: nil) - Selection ranges for the most recent content version.
data (type: String.t, default: nil) - User-created data for this annotation.
deleted (type: boolean(), default: nil) - Indicates that this annotation is deleted.
highlightStyle (type: String.t, default: nil) - The highlight style for this annotation.
id (type: String.t, default: nil) - Id of this annotation, in the form of a GUID.
kind (type: String.t, default: nil) - Resource type.
layerId (type: String.t, default: nil) - The layer this annotation is for.
layerSummary (type: GoogleApi.Books.V1.Model.AnnotationLayerSummary.t, default: nil) -
pageIds (type: list(String.t), default: nil) - Pages that this annotation spans.
selectedText (type: String.t, default: nil) - Excerpt from the volume.
selfLink (type: String.t, default: nil) - URL to this resource.
updated (type: String.t, default: nil) - Timestamp for the last time this annotation was modified.
volumeId (type: String.t, default: nil) - The volume that this annotation belongs to.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.Books.V1.Model.Annotation{
  afterSelectedText: String.t() | nil,
  beforeSelectedText: String.t() | nil,
  clientVersionRanges:
    GoogleApi.Books.V1.Model.AnnotationClientVersionRanges.t() | nil,
  created: String.t() | nil,
  currentVersionRanges:
    GoogleApi.Books.V1.Model.AnnotationCurrentVersionRanges.t() | nil,
  data: String.t() | nil,
  deleted: boolean() | nil,
  highlightStyle: String.t() | nil,
  id: String.t() | nil,
  kind: String.t() | nil,
  layerId: String.t() | nil,
  layerSummary: GoogleApi.Books.V1.Model.AnnotationLayerSummary.t() | nil,
  pageIds: [String.t()] | nil,
  selectedText: String.t() | nil,
  selfLink: String.t() | nil,
  updated: String.t() | nil,
  volumeId: String.t() | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.