Network.Google.Resource.Books.MyLibrary.Annotations.List

Retrieves a list of annotations, possibly filtered.

See: Books API Reference for books.mylibrary.annotations.list.

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))))))))))))))

A resource alias for books.mylibrary.annotations.list method which the MyLibraryAnnotationsList request conforms to.

Creating a Request

myLibraryAnnotationsList :: MyLibraryAnnotationsList

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:

• mlalContentVersion
• mlalShowDeleted
• mlalUpdatedMax
• mlalUpdatedMin
• mlalLayerIds
• mlalVolumeId
• mlalSource
• mlalPageToken
• mlalLayerId
• mlalMaxResults

data MyLibraryAnnotationsList

Retrieves a list of annotations, possibly filtered.

See: myLibraryAnnotationsList smart constructor.

Instances

Eq MyLibraryAnnotationsList

Defined in Network.Google.Resource.Books.MyLibrary.Annotations.List

Methods

(==) :: MyLibraryAnnotationsList -> MyLibraryAnnotationsList -> Bool

(/=) :: MyLibraryAnnotationsList -> MyLibraryAnnotationsList -> Bool

Data MyLibraryAnnotationsList

Defined in Network.Google.Resource.Books.MyLibrary.Annotations.List

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> MyLibraryAnnotationsList -> c MyLibraryAnnotationsList

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c MyLibraryAnnotationsList

toConstr :: MyLibraryAnnotationsList -> Constr

dataTypeOf :: MyLibraryAnnotationsList -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c MyLibraryAnnotationsList)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c MyLibraryAnnotationsList)

gmapT :: (forall b. Data b => b -> b) -> MyLibraryAnnotationsList -> MyLibraryAnnotationsList

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> MyLibraryAnnotationsList -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> MyLibraryAnnotationsList -> r

gmapQ :: (forall d. Data d => d -> u) -> MyLibraryAnnotationsList -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> MyLibraryAnnotationsList -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> MyLibraryAnnotationsList -> m MyLibraryAnnotationsList

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> MyLibraryAnnotationsList -> m MyLibraryAnnotationsList

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> MyLibraryAnnotationsList -> m MyLibraryAnnotationsList

Show MyLibraryAnnotationsList

Defined in Network.Google.Resource.Books.MyLibrary.Annotations.List

Methods

showsPrec :: Int -> MyLibraryAnnotationsList -> ShowS

show :: MyLibraryAnnotationsList -> String

showList :: [MyLibraryAnnotationsList] -> ShowS

Generic MyLibraryAnnotationsList

Defined in Network.Google.Resource.Books.MyLibrary.Annotations.List

Associated Types

type Rep MyLibraryAnnotationsList :: Type -> Type

Methods

from :: MyLibraryAnnotationsList -> Rep MyLibraryAnnotationsList x

to :: Rep MyLibraryAnnotationsList x -> MyLibraryAnnotationsList

GoogleRequest MyLibraryAnnotationsList

Defined in Network.Google.Resource.Books.MyLibrary.Annotations.List

Associated Types

type Rs MyLibraryAnnotationsList :: Type

type Scopes MyLibraryAnnotationsList :: [Symbol]

Methods

requestClient :: MyLibraryAnnotationsList -> GClient (Rs MyLibraryAnnotationsList)

type Rep MyLibraryAnnotationsList

Defined in Network.Google.Resource.Books.MyLibrary.Annotations.List

type Rep MyLibraryAnnotationsList = D1 (MetaData "MyLibraryAnnotationsList" "Network.Google.Resource.Books.MyLibrary.Annotations.List" "gogol-books-0.4.0-JsYtirrXlXLDWYQKuxGcRl" False) (C1 (MetaCons "MyLibraryAnnotationsList'" PrefixI True) (((S1 (MetaSel (Just "_mlalContentVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_mlalShowDeleted") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) :*: (S1 (MetaSel (Just "_mlalUpdatedMax") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_mlalUpdatedMin") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_mlalLayerIds") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe [Text]))))) :*: ((S1 (MetaSel (Just "_mlalVolumeId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_mlalSource") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_mlalPageToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 (MetaSel (Just "_mlalLayerId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_mlalMaxResults") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Textual Word32))))))))

type Scopes MyLibraryAnnotationsList

Defined in Network.Google.Resource.Books.MyLibrary.Annotations.List

type Scopes MyLibraryAnnotationsList = "https://www.googleapis.com/auth/books" ': ([] :: [Symbol])

type Rs MyLibraryAnnotationsList

Defined in Network.Google.Resource.Books.MyLibrary.Annotations.List

type Rs MyLibraryAnnotationsList = Annotations

Request Lenses

mlalContentVersion :: Lens' MyLibraryAnnotationsList (Maybe Text)

The content version for the requested volume.

mlalShowDeleted :: Lens' MyLibraryAnnotationsList (Maybe Bool)

Set to true to return deleted annotations. updatedMin must be in the request to use this. Defaults to false.

mlalUpdatedMax :: Lens' MyLibraryAnnotationsList (Maybe Text)

RFC 3339 timestamp to restrict to items updated prior to this timestamp (exclusive).

mlalUpdatedMin :: Lens' MyLibraryAnnotationsList (Maybe Text)

RFC 3339 timestamp to restrict to items updated since this timestamp (inclusive).

mlalLayerIds :: Lens' MyLibraryAnnotationsList [Text]

The layer ID(s) to limit annotation by.

mlalVolumeId :: Lens' MyLibraryAnnotationsList (Maybe Text)

The volume to restrict annotations to.

mlalSource :: Lens' MyLibraryAnnotationsList (Maybe Text)

String to identify the originator of this request.

mlalPageToken :: Lens' MyLibraryAnnotationsList (Maybe Text)

The value of the nextToken from the previous page.

mlalLayerId :: Lens' MyLibraryAnnotationsList (Maybe Text)

The layer ID to limit annotation by.

mlalMaxResults :: Lens' MyLibraryAnnotationsList (Maybe Word32)

Maximum number of results to return