google_api_books v0.8.0 GoogleApi.Books.V1.Model.Annotation View Source

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: DateTime.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: books#annotation) - 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: DateTime.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.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Link to this type

t()

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

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.