Packages
Books API client library. The Google Books API allows clients to access the Google Books repository.
Current section
Files
Jump to
Current section
Files
lib/google_api/books/v1/model/annotation.ex
# Copyright 2017 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# NOTE: This class is auto generated by the swagger code generator program.
# https://github.com/swagger-api/swagger-codegen.git
# Do not edit the class manually.
defmodule GoogleApi.Books.V1.Model.Annotation do
@moduledoc """
## 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`.
"""
use GoogleApi.Gax.ModelBase
@type t :: %__MODULE__{
: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 => list(any()),
:selectedText => any(),
:selfLink => any(),
:updated => DateTime.t(),
:volumeId => any()
}
field(:afterSelectedText)
field(:beforeSelectedText)
field(:clientVersionRanges, as: GoogleApi.Books.V1.Model.AnnotationClientVersionRanges)
field(:created, as: DateTime)
field(:currentVersionRanges, as: GoogleApi.Books.V1.Model.AnnotationCurrentVersionRanges)
field(:data)
field(:deleted)
field(:highlightStyle)
field(:id)
field(:kind)
field(:layerId)
field(:layerSummary, as: GoogleApi.Books.V1.Model.AnnotationLayerSummary)
field(:pageIds, type: :list)
field(:selectedText)
field(:selfLink)
field(:updated, as: DateTime)
field(:volumeId)
end
defimpl Poison.Decoder, for: GoogleApi.Books.V1.Model.Annotation do
def decode(value, options) do
GoogleApi.Books.V1.Model.Annotation.decode(value, options)
end
end
defimpl Poison.Encoder, for: GoogleApi.Books.V1.Model.Annotation do
def encode(value, options) do
GoogleApi.Gax.ModelBase.encode(value, options)
end
end