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.BatchUpdate

Contents

REST Resource
Creating a Request
Request Lenses

Description

Applies one or more updates to the document. Each request is validated before being applied. If any request is not valid, then the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. Other requests do not need to return information; these each return an empty reply. The order of replies matches that of the requests. For example, suppose you call batchUpdate with four updates, and only the third one returns information. The response would have two empty replies, the reply to the third request, and another empty reply, in that order. Because other users may be editing the document, the document might not exactly reflect your changes: your changes may be altered with respect to collaborator changes. If there are no collaborators, the document should reflect your changes. In any case, the updates in your request are guaranteed to be applied together atomically.

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

Synopsis

type DocumentsBatchUpdateResource = "v1" :> ("documents" :> (CaptureMode "documentId" "batchUpdate" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] BatchUpdateDocumentRequest :> Post '[JSON] BatchUpdateDocumentResponse)))))))))
documentsBatchUpdate :: Text -> BatchUpdateDocumentRequest -> DocumentsBatchUpdate
data DocumentsBatchUpdate
dbuXgafv :: Lens' DocumentsBatchUpdate (Maybe Xgafv)
dbuDocumentId :: Lens' DocumentsBatchUpdate Text
dbuUploadProtocol :: Lens' DocumentsBatchUpdate (Maybe Text)
dbuAccessToken :: Lens' DocumentsBatchUpdate (Maybe Text)
dbuUploadType :: Lens' DocumentsBatchUpdate (Maybe Text)
dbuPayload :: Lens' DocumentsBatchUpdate BatchUpdateDocumentRequest
dbuCallback :: Lens' DocumentsBatchUpdate (Maybe Text)

REST Resource

type DocumentsBatchUpdateResource = "v1" :> ("documents" :> (CaptureMode "documentId" "batchUpdate" Text :> (QueryParam "$.xgafv" Xgafv :> (QueryParam "upload_protocol" Text :> (QueryParam "access_token" Text :> (QueryParam "uploadType" Text :> (QueryParam "callback" Text :> (QueryParam "alt" AltJSON :> (ReqBody '[JSON] BatchUpdateDocumentRequest :> Post '[JSON] BatchUpdateDocumentResponse))))))))) Source #

A resource alias for docs.documents.batchUpdate method which the DocumentsBatchUpdate request conforms to.

Creating a Request

documentsBatchUpdate Source #

Arguments

:: Text	`dbuDocumentId`
-> BatchUpdateDocumentRequest	`dbuPayload`
-> DocumentsBatchUpdate

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

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

data DocumentsBatchUpdate Source #

Applies one or more updates to the document. Each request is validated before being applied. If any request is not valid, then the entire request will fail and nothing will be applied. Some requests have replies to give you some information about how they are applied. Other requests do not need to return information; these each return an empty reply. The order of replies matches that of the requests. For example, suppose you call batchUpdate with four updates, and only the third one returns information. The response would have two empty replies, the reply to the third request, and another empty reply, in that order. Because other users may be editing the document, the document might not exactly reflect your changes: your changes may be altered with respect to collaborator changes. If there are no collaborators, the document should reflect your changes. In any case, the updates in your request are guaranteed to be applied together atomically.

See: documentsBatchUpdate smart constructor.

Instances

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

Request Lenses

dbuXgafv :: Lens' DocumentsBatchUpdate (Maybe Xgafv) Source #

V1 error format.

dbuDocumentId :: Lens' DocumentsBatchUpdate Text Source #

The ID of the document to update.

dbuUploadProtocol :: Lens' DocumentsBatchUpdate (Maybe Text) Source #

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

dbuAccessToken :: Lens' DocumentsBatchUpdate (Maybe Text) Source #

OAuth access token.

dbuUploadType :: Lens' DocumentsBatchUpdate (Maybe Text) Source #

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

dbuPayload :: Lens' DocumentsBatchUpdate BatchUpdateDocumentRequest Source #

Multipart request metadata.

dbuCallback :: Lens' DocumentsBatchUpdate (Maybe Text) Source #

JSONP