| Copyright | (c) 2015 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.Google.Resource.Books.MyLibrary.Annotations.List
Description
Retrieves a list of annotations, possibly filtered.
See: Books API Reference for books.mylibrary.annotations.list.
- type MyLibraryAnnotationsListResource = "books" :> ("v1" :> ("mylibrary" :> ("annotations" :> (QueryParam "contentVersion" Text :> (QueryParam "showDeleted" Bool :> (QueryParam "updatedMax" Text :> (QueryParam "updatedMin" Text :> (QueryParams "layerIds" Text :> (QueryParam "volumeId" Text :> (QueryParam "source" Text :> (QueryParam "pageToken" Text :> (QueryParam "layerId" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get `[JSON]` Annotations))))))))))))))
- myLibraryAnnotationsList :: MyLibraryAnnotationsList
- data MyLibraryAnnotationsList
- mlalContentVersion :: Lens' MyLibraryAnnotationsList (Maybe Text)
- mlalShowDeleted :: Lens' MyLibraryAnnotationsList (Maybe Bool)
- mlalUpdatedMax :: Lens' MyLibraryAnnotationsList (Maybe Text)
- mlalUpdatedMin :: Lens' MyLibraryAnnotationsList (Maybe Text)
- mlalLayerIds :: Lens' MyLibraryAnnotationsList [Text]
- mlalVolumeId :: Lens' MyLibraryAnnotationsList (Maybe Text)
- mlalSource :: Lens' MyLibraryAnnotationsList (Maybe Text)
- mlalPageToken :: Lens' MyLibraryAnnotationsList (Maybe Text)
- mlalLayerId :: Lens' MyLibraryAnnotationsList (Maybe Text)
- mlalMaxResults :: Lens' MyLibraryAnnotationsList (Maybe Word32)
REST Resource
type MyLibraryAnnotationsListResource = "books" :> ("v1" :> ("mylibrary" :> ("annotations" :> (QueryParam "contentVersion" Text :> (QueryParam "showDeleted" Bool :> (QueryParam "updatedMax" Text :> (QueryParam "updatedMin" Text :> (QueryParams "layerIds" Text :> (QueryParam "volumeId" Text :> (QueryParam "source" Text :> (QueryParam "pageToken" Text :> (QueryParam "layerId" Text :> (QueryParam "maxResults" (Textual Word32) :> (QueryParam "alt" AltJSON :> Get `[JSON]` Annotations)))))))))))))) Source
A resource alias for books.mylibrary.annotations.list method which the
MyLibraryAnnotationsList request conforms to.
Creating a Request
myLibraryAnnotationsList :: MyLibraryAnnotationsList Source
Creates a value of MyLibraryAnnotationsList with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data MyLibraryAnnotationsList Source
Retrieves a list of annotations, possibly filtered.
See: myLibraryAnnotationsList smart constructor.
Request Lenses
mlalContentVersion :: Lens' MyLibraryAnnotationsList (Maybe Text) Source
The content version for the requested volume.
mlalShowDeleted :: Lens' MyLibraryAnnotationsList (Maybe Bool) Source
Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.
mlalUpdatedMax :: Lens' MyLibraryAnnotationsList (Maybe Text) Source
RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).
mlalUpdatedMin :: Lens' MyLibraryAnnotationsList (Maybe Text) Source
RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).
mlalLayerIds :: Lens' MyLibraryAnnotationsList [Text] Source
The layer ID(s) to limit annotation by.
mlalVolumeId :: Lens' MyLibraryAnnotationsList (Maybe Text) Source
The volume to restrict annotations to.
mlalSource :: Lens' MyLibraryAnnotationsList (Maybe Text) Source
String to identify the originator of this request.
mlalPageToken :: Lens' MyLibraryAnnotationsList (Maybe Text) Source
The value of the nextToken from the previous page.
mlalLayerId :: Lens' MyLibraryAnnotationsList (Maybe Text) Source
The layer ID to limit annotation by.
mlalMaxResults :: Lens' MyLibraryAnnotationsList (Maybe Word32) Source
Maximum number of results to return