Class MediaResource.DownloadRequest
Method for media download. Download is supported on the URI /v1/media/{+name}?alt=media
.
Inheritance
Inherited Members
Namespace: Google.Apis.YouTubeReporting .v1
Assembly: Google.Apis.YouTubeReporting.v1.dll
Syntax
public class MediaResource.DownloadRequest : YouTubeReportingBaseServiceRequest<GdataMedia>, IClientServiceRequest<GdataMedia>, IClientServiceRequest
Constructors
DownloadRequest(IClientService, string)
Constructs a new Download request.
Declaration
public DownloadRequest(IClientService service, string resourceName)
Parameters
Type | Name | Description |
---|---|---|
IClient |
service | |
string | resourceName |
Properties
HttpMethod
Gets the HTTP method.
Declaration
public override string HttpMethod { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
MediaDownloader
Gets the media downloader.
Declaration
public IMediaDownloader MediaDownloader { get; }
Property Value
Type | Description |
---|---|
IMedia |
MethodName
Gets the method name.
Declaration
public override string MethodName { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
ResourceName
Name of the media that is being downloaded.
Declaration
[RequestParameter("resourceName", RequestParameterType.Path)]
public virtual string ResourceName { get; }
Property Value
Type | Description |
---|---|
string |
RestPath
Gets the REST path.
Declaration
public override string RestPath { get; }
Property Value
Type | Description |
---|---|
string |
Overrides
Methods
Download(Stream)
Synchronously download the media into the given stream.
Warning: This method hides download errors; use Download
Declaration
public virtual void Download(Stream stream)
Parameters
Type | Name | Description |
---|---|---|
Stream | stream |
Remarks
This method uses the Media
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<IDownload |
Remarks
This method uses the Media
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 | |
Cancellation |
cancellationToken |
Returns
Type | Description |
---|---|
Task<IDownload |
Remarks
This method uses the Media
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 | |
Range |
range |
Returns
Type | Description |
---|---|
IDownload |
Remarks
This method uses the Media
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 | |
Range |
range | |
Cancellation |
cancellationToken |
Returns
Type | Description |
---|---|
Task<IDownload |
Remarks
This method uses the Media
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 |
---|---|
IDownload |
The final status of the download; including whether the download succeeded or failed. |
Remarks
This method uses the Media
InitParameters()
Initializes Download parameter list.
Declaration
protected override void InitParameters()