Copyright	(c) 2015-2016 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.Docs.Documents.Get

Contents

REST Resource
Creating a Request
Request Lenses

Description

Gets the latest version of the specified document.

See: Google Docs API Reference for docs.documents.get.

Synopsis

type DocumentsGetResource = "v1" :> ("documents" :> (Capture "documentId" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "suggestionsViewMode" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] Document)))))))))
documentsGet :: Text -> DocumentsGet
data DocumentsGet
dgXgafv :: Lens' DocumentsGet (Maybe Xgafv)
dgDocumentId :: Lens' DocumentsGet Text
dgUploadProtocol :: Lens' DocumentsGet (Maybe Text)
dgAccessToken :: Lens' DocumentsGet (Maybe Text)
dgUploadType :: Lens' DocumentsGet (Maybe Text)
dgSuggestionsViewMode :: Lens' DocumentsGet (Maybe Text)
dgCallback :: Lens' DocumentsGet (Maybe Text)

REST Resource

type DocumentsGetResource = "v1" :> ("documents" :> (Capture "documentId" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "suggestionsViewMode" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> Get '[JSON] Document))))))))) Source #

A resource alias for docs.documents.get method which the DocumentsGet request conforms to.

Creating a Request

documentsGet Source #

Arguments

:: Text	`dgDocumentId`
-> DocumentsGet

Creates a value of DocumentsGet with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

data DocumentsGet Source #

Gets the latest version of the specified document.

See: documentsGet smart constructor.

Instances

Eq DocumentsGet Source #
Instance details Defined in Network.Google.Resource.Docs.Documents.Get Methods (==) :: DocumentsGet -> DocumentsGet -> Bool # (/=) :: DocumentsGet -> DocumentsGet -> Bool #
Data DocumentsGet Source #
Instance details Defined in Network.Google.Resource.Docs.Documents.Get Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DocumentsGet -> c DocumentsGet # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DocumentsGet # toConstr :: DocumentsGet -> Constr # dataTypeOf :: DocumentsGet -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c DocumentsGet) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DocumentsGet) # gmapT :: (forall b. Data b => b -> b) -> DocumentsGet -> DocumentsGet # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DocumentsGet -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DocumentsGet -> r # gmapQ :: (forall d. Data d => d -> u) -> DocumentsGet -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> DocumentsGet -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> DocumentsGet -> m DocumentsGet # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DocumentsGet -> m DocumentsGet # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DocumentsGet -> m DocumentsGet #
Show DocumentsGet Source #
Instance details Defined in Network.Google.Resource.Docs.Documents.Get Methods showsPrec :: Int -> DocumentsGet -> ShowS # show :: DocumentsGet -> String # showList :: [DocumentsGet] -> ShowS #
Generic DocumentsGet Source #
Instance details Defined in Network.Google.Resource.Docs.Documents.Get Associated Types type Rep DocumentsGet :: Type -> Type # Methods from :: DocumentsGet -> Rep DocumentsGet x # to :: Rep DocumentsGet x -> DocumentsGet #
GoogleRequest DocumentsGet Source #
Instance details Defined in Network.Google.Resource.Docs.Documents.Get Associated Types type Rs DocumentsGet :: Type # type Scopes DocumentsGet :: [Symbol] # Methods requestClient :: DocumentsGet -> GClient (Rs DocumentsGet) #
type Rep DocumentsGet Source #
Instance details Defined in Network.Google.Resource.Docs.Documents.Get type Rep DocumentsGet = D1 (MetaData "DocumentsGet" "Network.Google.Resource.Docs.Documents.Get" "gogol-docs-0.5.0-ENmbq05ppI7HbEsEKEkZFk" False) (C1 (MetaCons "DocumentsGet'" PrefixI True) ((S1 (MetaSel (Just "_dgXgafv") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Xgafv)) :: (S1 (MetaSel (Just "_dgDocumentId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :: S1 (MetaSel (Just "_dgUploadProtocol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 (MetaSel (Just "_dgAccessToken") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_dgUploadType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :: (S1 (MetaSel (Just "_dgSuggestionsViewMode") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :: S1 (MetaSel (Just "_dgCallback") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))
type Scopes DocumentsGet Source #
Instance details Defined in Network.Google.Resource.Docs.Documents.Get type Scopes DocumentsGet = "https://www.googleapis.com/auth/documents" ': ("https://www.googleapis.com/auth/documents.readonly" ': ("https://www.googleapis.com/auth/drive" ': ("https://www.googleapis.com/auth/drive.file" ': ("https://www.googleapis.com/auth/drive.readonly" ': ([] :: [Symbol])))))
type Rs DocumentsGet Source #
Instance details Defined in Network.Google.Resource.Docs.Documents.Get type Rs DocumentsGet = Document

Request Lenses

dgXgafv :: Lens' DocumentsGet (Maybe Xgafv) Source #

V1 error format.

dgDocumentId :: Lens' DocumentsGet Text Source #

The ID of the document to retrieve.

dgUploadProtocol :: Lens' DocumentsGet (Maybe Text) Source #

Upload protocol for media (e.g. "raw", "multipart").

dgAccessToken :: Lens' DocumentsGet (Maybe Text) Source #

OAuth access token.

dgUploadType :: Lens' DocumentsGet (Maybe Text) Source #

Legacy upload protocol for media (e.g. "media", "multipart").

dgSuggestionsViewMode :: Lens' DocumentsGet (Maybe Text) Source #

The suggestions view mode to apply to the document. This allows viewing the document with all suggestions inline, accepted or rejected. If one is not specified, DEFAULT_FOR_CURRENT_ACCESS is used.

dgCallback :: Lens' DocumentsGet (Maybe Text) Source #

JSONP