Class DocumentsResource.GetRequest

Gets the latest version of the specified document.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<Document>
DocsBaseServiceRequest<Document>
DocumentsResource.GetRequest
Implements
Inherited Members
Namespace: Google.Apis.Docs.v1
Assembly: Google.Apis.Docs.v1.dll
Syntax
public class DocumentsResource.GetRequest : DocsBaseServiceRequest<Document>, IClientServiceRequest<Document>, IClientServiceRequest

Constructors

GetRequest(IClientService, string)

Constructs a new Get request.

Declaration
public GetRequest(IClientService service, string documentId)
Parameters
Type Name Description
IClientService service
string documentId

Properties

CommentsViewMode

The comments view mode to apply to the document. This allows viewing the document with comments omitted or included. If one is not specified, COMMENTS_VIEW_MODE_OMITTED is used. If you set comments_view_mode to any value, you must also set include_tabs_content to true or use a field mask that references the Document.tabs field (or any subfield). If you set comments_view_mode to COMMENTS_VIEW_MODE_INCLUDED, you must also explicitly set suggestions_view_mode to SUGGESTIONS_INLINE. If you set comments_view_mode to COMMENTS_VIEW_MODE_INCLUDED or COMMENTS_VIEW_MODE_DEFAULT_FOR_CURRENT_ACCESS, you may not set suggestions_view_mode to PREVIEW_WITHOUT_SUGGESTIONS or PREVIEW_SUGGESTIONS_ACCEPTED. Developer Preview.

Declaration
[RequestParameter("commentsViewMode", RequestParameterType.Query)]
public virtual DocumentsResource.GetRequest.CommentsViewModeEnum? CommentsViewMode { get; set; }
Property Value
Type Description
DocumentsResource.GetRequest.CommentsViewModeEnum?

DocumentId

The ID of the document to retrieve.

Declaration
[RequestParameter("documentId", RequestParameterType.Path)]
public virtual string DocumentId { get; }
Property Value
Type Description
string

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

IncludeTabsContent

Whether to populate the Document.tabs field instead of the text content fields like body and documentStyle on Document. - When true: Document content populates in the Document.tabs field instead of the text content fields in Document. - When false: The content of the document's first tab populates the content fields in Document excluding Document.tabs. If a document has only one tab, then that tab is used to populate the document content. Document.tabs will be empty. If you use a field mask that references the Document.tabs field (or any subfield), the API implicitly treats the request as if you set include_tabs_content to true.

Declaration
[RequestParameter("includeTabsContent", RequestParameterType.Query)]
public virtual bool? IncludeTabsContent { get; set; }
Property Value
Type Description
bool?

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

SuggestionsViewMode

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.

Declaration
[RequestParameter("suggestionsViewMode", RequestParameterType.Query)]
public virtual DocumentsResource.GetRequest.SuggestionsViewModeEnum? SuggestionsViewMode { get; set; }
Property Value
Type Description
DocumentsResource.GetRequest.SuggestionsViewModeEnum?

Methods

InitParameters()

Initializes Get parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements