google_api_books v0.5.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 nil.
  • 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 nil.
  • clientVersionRanges (GoogleApi.Books.V1.Model.AnnotationClientVersionRanges.t): Selection ranges sent from the client. Defaults to nil.
  • created (DateTime.t): Timestamp for the created time of this annotation. Defaults to nil.
  • currentVersionRanges (GoogleApi.Books.V1.Model.AnnotationCurrentVersionRanges.t): Selection ranges for the most recent content version. Defaults to nil.
  • data (String.t): User-created data for this annotation. Defaults to nil.
  • deleted (boolean()): Indicates that this annotation is deleted. Defaults to nil.
  • highlightStyle (String.t): The highlight style for this annotation. Defaults to nil.
  • id (String.t): Id of this annotation, in the form of a GUID. Defaults to nil.
  • kind (String.t): Resource type. Defaults to books#annotation.
  • layerId (String.t): The layer this annotation is for. Defaults to nil.
  • layerSummary (GoogleApi.Books.V1.Model.AnnotationLayerSummary.t): Defaults to nil.
  • pageIds (list(String.t)): Pages that this annotation spans. Defaults to nil.
  • selectedText (String.t): Excerpt from the volume. Defaults to nil.
  • selfLink (String.t): URL to this resource. Defaults to nil.
  • updated (DateTime.t): Timestamp for the last time this annotation was modified. Defaults to nil.
  • volumeId (String.t): The volume that this annotation belongs to. Defaults to nil.

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.