Class FilesResource.ExportRequest

Exports a Google Workspace document to the requested MIME type and returns exported byte content. Note that the exported content is limited to 10MB.

Inheritance
System.Object
Google.Apis.Requests.ClientServiceRequest
Google.Apis.Requests.ClientServiceRequest<System.String>
DriveBaseServiceRequest<System.String>
FilesResource.ExportRequest
Implements
Google.Apis.Requests.IClientServiceRequest<System.String>
Google.Apis.Requests.IClientServiceRequest
Inherited Members
Google.Apis.Requests.ClientServiceRequest<System.String>.Execute()
Google.Apis.Requests.ClientServiceRequest<System.String>.ExecuteAsStream()
Google.Apis.Requests.ClientServiceRequest<System.String>.ExecuteAsync()
Google.Apis.Requests.ClientServiceRequest<System.String>.ExecuteAsync(System.Threading.CancellationToken)
Google.Apis.Requests.ClientServiceRequest<System.String>.ExecuteAsStreamAsync()
Google.Apis.Requests.ClientServiceRequest<System.String>.ExecuteAsStreamAsync(System.Threading.CancellationToken)
Google.Apis.Requests.ClientServiceRequest<System.String>.CreateRequest(System.Nullable<System.Boolean>)
Google.Apis.Requests.ClientServiceRequest<System.String>.GenerateRequestUri()
Google.Apis.Requests.ClientServiceRequest<System.String>.GetBody()
Google.Apis.Requests.ClientServiceRequest<System.String>.GetDefaultETagAction(System.String)
Google.Apis.Requests.ClientServiceRequest<System.String>.ETagAction
Google.Apis.Requests.ClientServiceRequest<System.String>.ModifyRequest
Google.Apis.Requests.ClientServiceRequest<System.String>.ValidateParameters
Google.Apis.Requests.ClientServiceRequest<System.String>.RequestParameters
Google.Apis.Requests.ClientServiceRequest<System.String>.Service
Google.Apis.Requests.ClientServiceRequest._unsuccessfulResponseHandlers
Google.Apis.Requests.ClientServiceRequest._exceptionHandlers
Google.Apis.Requests.ClientServiceRequest._executeInterceptors
Google.Apis.Requests.ClientServiceRequest.AddUnsuccessfulResponseHandler(Google.Apis.Http.IHttpUnsuccessfulResponseHandler)
Google.Apis.Requests.ClientServiceRequest.AddExceptionHandler(Google.Apis.Http.IHttpExceptionHandler)
Google.Apis.Requests.ClientServiceRequest.AddExecuteInterceptor(Google.Apis.Http.IHttpExecuteInterceptor)
Google.Apis.Requests.ClientServiceRequest.Credential
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Google.Apis.Drive.v2
Assembly: Google.Apis.Drive.v2.dll
Syntax
public class ExportRequest : DriveBaseServiceRequest<string>, IClientServiceRequest<string>, IClientServiceRequest

Constructors

ExportRequest(IClientService, String, String)

Constructs a new Export request.

Declaration
public ExportRequest(IClientService service, string fileId, string mimeType)
Parameters
Type Name Description
Google.Apis.Services.IClientService service
System.String fileId
System.String mimeType

Properties

FileId

The ID of the file.

Declaration
[RequestParameter("fileId", RequestParameterType.Path)]
public virtual string FileId { get; }
Property Value
Type Description
System.String

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<System.String>.HttpMethod

MediaDownloader

Gets the media downloader.

Declaration
public IMediaDownloader MediaDownloader { get; }
Property Value
Type Description
Google.Apis.Download.IMediaDownloader

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<System.String>.MethodName

MimeType

The MIME type of the format requested for this export.

Declaration
[RequestParameter("mimeType", RequestParameterType.Query)]
public virtual string MimeType { get; }
Property Value
Type Description
System.String

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
System.String
Overrides
Google.Apis.Requests.ClientServiceRequest<System.String>.RestPath

Methods

Download(Stream)

Synchronously download the media into the given stream.

Warning: This method hides download errors; use DownloadWithStatus(Stream) instead.

Declaration
public virtual void Download(Stream stream)
Parameters
Type Name Description
System.IO.Stream stream
Remarks

This method uses the MediaDownloader property to perform the download. Progress event handlers and other configuration may be performed using that property prior to calling this method.

DownloadAsync(Stream)

Asynchronously download the media into the given stream.

Declaration
public virtual Task<IDownloadProgress> DownloadAsync(Stream stream)
Parameters
Type Name Description
System.IO.Stream stream
Returns
Type Description
System.Threading.Tasks.Task<Google.Apis.Download.IDownloadProgress>
Remarks

This method uses the MediaDownloader property to perform the download. Progress event handlers and other configuration may be performed using that property prior to calling this method.

DownloadAsync(Stream, CancellationToken)

Asynchronously download the media into the given stream.

Declaration
public virtual Task<IDownloadProgress> DownloadAsync(Stream stream, CancellationToken cancellationToken)
Parameters
Type Name Description
System.IO.Stream stream
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<Google.Apis.Download.IDownloadProgress>
Remarks

This method uses the MediaDownloader property to perform the download. Progress event handlers and other configuration may be performed using that property prior to calling this method.

DownloadRange(Stream, RangeHeaderValue)

Synchronously download a range of the media into the given stream.

Declaration
public virtual IDownloadProgress DownloadRange(Stream stream, RangeHeaderValue range)
Parameters
Type Name Description
System.IO.Stream stream
System.Net.Http.Headers.RangeHeaderValue range
Returns
Type Description
Google.Apis.Download.IDownloadProgress
Remarks

This method uses the MediaDownloader property to perform the download. Progress event handlers and other configuration may be performed using that property prior to calling this method.

DownloadRangeAsync(Stream, RangeHeaderValue, CancellationToken)

Asynchronously download a range of the media into the given stream.

Declaration
public virtual Task<IDownloadProgress> DownloadRangeAsync(Stream stream, RangeHeaderValue range, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type Name Description
System.IO.Stream stream
System.Net.Http.Headers.RangeHeaderValue range
System.Threading.CancellationToken cancellationToken
Returns
Type Description
System.Threading.Tasks.Task<Google.Apis.Download.IDownloadProgress>
Remarks

This method uses the MediaDownloader property to perform the download. Progress event handlers and other configuration may be performed using that property prior to calling this method.

DownloadWithStatus(Stream)

Synchronously download the media into the given stream.

Declaration
public virtual IDownloadProgress DownloadWithStatus(Stream stream)
Parameters
Type Name Description
System.IO.Stream stream
Returns
Type Description
Google.Apis.Download.IDownloadProgress

The final status of the download; including whether the download succeeded or failed.
Remarks

This method uses the MediaDownloader property to perform the download. Progress event handlers and other configuration may be performed using that property prior to calling this method.

InitParameters()

Initializes Export parameter list.

Declaration
protected override void InitParameters()
Overrides
Google.Apis.Drive.v2.DriveBaseServiceRequest<System.String>.InitParameters()

Implements

Google.Apis.Requests.IClientServiceRequest<TResponse>
Google.Apis.Requests.IClientServiceRequest