target.apidocs.com.google.api.services.docs.v1.Docs.Documents.html Maven / Gradle / Ivy
Docs.Documents (Google Docs API v1-rev20191010-1.30.3)
com.google.api.services.docs.v1
Class Docs.Documents
- java.lang.Object
-
- com.google.api.services.docs.v1.Docs.Documents
-
-
Nested Class Summary
Nested Classes
Modifier and Type
Class and Description
class
Docs.Documents.BatchUpdate
class
Docs.Documents.Create
class
Docs.Documents.Get
-
Constructor Summary
Constructors
Constructor and Description
Documents()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
Docs.Documents.BatchUpdate
batchUpdate(String documentId,
BatchUpdateDocumentRequest content)
Applies one or more updates to the document.
Docs.Documents.Create
create(Document content)
Creates a blank document using the title given in the request.
Docs.Documents.Get
get(String documentId)
Gets the latest version of the specified document.
-
-
Method Detail
-
batchUpdate
public Docs.Documents.BatchUpdate batchUpdate(String documentId,
BatchUpdateDocumentRequest content)
throws IOException
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.
Create a request for the method "documents.batchUpdate".
This request holds the parameters needed by the docs server. After setting any optional
parameters, call the AbstractGoogleClientRequest.execute()
method to invoke the remote operation.
- Parameters:
documentId
- The ID of the document to update.
content
- the BatchUpdateDocumentRequest
- Returns:
- the request
- Throws:
IOException
-
create
public Docs.Documents.Create create(Document content)
throws IOException
Creates a blank document using the title given in the request. Other fields in the request,
including any provided content, are ignored.
Returns the created document.
Create a request for the method "documents.create".
This request holds the parameters needed by the docs server. After setting any optional
parameters, call the AbstractGoogleClientRequest.execute()
method to invoke the remote operation.
- Parameters:
content
- the Document
- Returns:
- the request
- Throws:
IOException
-
get
public Docs.Documents.Get get(String documentId)
throws IOException
Gets the latest version of the specified document.
Create a request for the method "documents.get".
This request holds the parameters needed by the docs server. After setting any optional
parameters, call the AbstractGoogleClientRequest.execute()
method to invoke the remote operation.
- Parameters:
documentId
- The ID of the document to retrieve.
- Returns:
- the request
- Throws:
IOException
Copyright © 2011–2019 Google. All rights reserved.
© 2015 - 2025 Weber Informatics LLC | Privacy Policy