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

Attributes

  • afterSelectedText (String.t): 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. Defaults to: null.
  • beforeSelectedText (String.t): 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. Defaults to: null.
  • clientVersionRanges (AnnotationClientVersionRanges): Defaults to: null.
  • created (DateTime.t): Timestamp for the created time of this annotation. Defaults to: null.
  • currentVersionRanges (AnnotationCurrentVersionRanges): Defaults to: null.
  • data (String.t): User-created data for this annotation. Defaults to: null.
  • deleted (boolean()): Indicates that this annotation is deleted. Defaults to: null.
  • highlightStyle (String.t): The highlight style for this annotation. Defaults to: null.
  • id (String.t): Id of this annotation, in the form of a GUID. Defaults to: null.
  • kind (String.t): Resource type. Defaults to: null.
  • layerId (String.t): The layer this annotation is for. Defaults to: null.
  • layerSummary (AnnotationLayerSummary): Defaults to: null.
  • pageIds ([String.t]): Pages that this annotation spans. Defaults to: null.
  • selectedText (String.t): Excerpt from the volume. Defaults to: null.
  • selfLink (String.t): URL to this resource. Defaults to: null.
  • updated (DateTime.t): Timestamp for the last time this annotation was modified. Defaults to: null.
  • volumeId (String.t): The volume that this annotation belongs to. Defaults to: null.

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: any(),
  beforeSelectedText: any(),
  clientVersionRanges:
    GoogleApi.Books.V1.Model.AnnotationClientVersionRanges.t(),
  created: DateTime.t(),
  currentVersionRanges:
    GoogleApi.Books.V1.Model.AnnotationCurrentVersionRanges.t(),
  data: any(),
  deleted: any(),
  highlightStyle: any(),
  id: any(),
  kind: any(),
  layerId: any(),
  layerSummary: GoogleApi.Books.V1.Model.AnnotationLayerSummary.t(),
  pageIds: [any()],
  selectedText: any(),
  selfLink: any(),
  updated: DateTime.t(),
  volumeId: 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.