Show / Hide Table of Contents

Class MediaResource.DownloadRequest

Gets an attachment. To download attachment media via REST requires the alt=media query parameter. Returns a 400 bad request error if attachment media is not available in the requested MIME type.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<Attachment>
KeepBaseServiceRequest<Attachment>
MediaResource.DownloadRequest
Implements
IClientServiceRequest<Attachment>
IClientServiceRequest
Inherited Members
KeepBaseServiceRequest<Attachment>.Xgafv
KeepBaseServiceRequest<Attachment>.AccessToken
KeepBaseServiceRequest<Attachment>.Alt
KeepBaseServiceRequest<Attachment>.Callback
KeepBaseServiceRequest<Attachment>.Fields
KeepBaseServiceRequest<Attachment>.Key
KeepBaseServiceRequest<Attachment>.OauthToken
KeepBaseServiceRequest<Attachment>.PrettyPrint
KeepBaseServiceRequest<Attachment>.QuotaUser
KeepBaseServiceRequest<Attachment>.UploadType
KeepBaseServiceRequest<Attachment>.UploadProtocol
ClientServiceRequest<Attachment>.Execute()
ClientServiceRequest<Attachment>.ExecuteAsStream()
ClientServiceRequest<Attachment>.ExecuteAsync()
ClientServiceRequest<Attachment>.ExecuteAsync(CancellationToken)
ClientServiceRequest<Attachment>.ExecuteAsStreamAsync()
ClientServiceRequest<Attachment>.ExecuteAsStreamAsync(CancellationToken)
ClientServiceRequest<Attachment>.CreateRequest(bool?)
ClientServiceRequest<Attachment>.GenerateRequestUri()
ClientServiceRequest<Attachment>.GetBody()
ClientServiceRequest<Attachment>.GetDefaultETagAction(string)
ClientServiceRequest<Attachment>.ETagAction
ClientServiceRequest<Attachment>.ModifyRequest
ClientServiceRequest<Attachment>.ValidateParameters
ClientServiceRequest<Attachment>.ApiVersion
ClientServiceRequest<Attachment>.RequestParameters
ClientServiceRequest<Attachment>.Service
ClientServiceRequest._unsuccessfulResponseHandlers
ClientServiceRequest._exceptionHandlers
ClientServiceRequest._executeInterceptors
ClientServiceRequest.AddUnsuccessfulResponseHandler(IHttpUnsuccessfulResponseHandler)
ClientServiceRequest.AddExceptionHandler(IHttpExceptionHandler)
ClientServiceRequest.AddExecuteInterceptor(IHttpExecuteInterceptor)
ClientServiceRequest.Credential
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Keep.v1
Assembly: Google.Apis.Keep.v1.dll
Syntax
public class MediaResource.DownloadRequest : KeepBaseServiceRequest<Attachment>, IClientServiceRequest<Attachment>, IClientServiceRequest

Constructors

DownloadRequest(IClientService, string)

Constructs a new Download request.

Declaration
public DownloadRequest(IClientService service, string name)
Parameters
Type Name Description
IClientService service
string name

Properties

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<Attachment>.HttpMethod

MediaDownloader

Gets the media downloader.

Declaration
public IMediaDownloader MediaDownloader { get; }
Property Value
Type Description
IMediaDownloader

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<Attachment>.MethodName

MimeType

The IANA MIME type format requested. The requested MIME type must be one specified in the attachment.mime_type. Required when downloading attachment media and ignored otherwise.

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

Name

Required. The name of the attachment.

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

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides
ClientServiceRequest<Attachment>.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
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
Stream stream
Returns
Type Description
Task<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
Stream stream
CancellationToken cancellationToken
Returns
Type Description
Task<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
Stream stream
RangeHeaderValue range
Returns
Type Description
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)
Parameters
Type Name Description
Stream stream
RangeHeaderValue range
CancellationToken cancellationToken
Returns
Type Description
Task<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
Stream stream
Returns
Type Description
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 Download parameter list.

Declaration
protected override void InitParameters()
Overrides
KeepBaseServiceRequest<Attachment>.InitParameters()

Implements

IClientServiceRequest<TResponse>
IClientServiceRequest
In this article
Back to top Generated by DocFX