Class ResumableUpload<TRequest, TResponse>
Media upload which uses Google's resumable media upload protocol to upload data. The version with two types contains both a request object and a response object.
Inherited Members
Namespace: Google.Apis.Upload
Assembly: Google.Apis.dll
Syntax
public class ResumableUpload<TRequest, TResponse> : ResumableUpload<TRequest>
Type Parameters
Name | Description |
---|---|
TRequest | The type of the body of this request. Generally this should be the metadata related to the content to be uploaded. Must be serializable to/from JSON. |
TResponse | The type of the response body. |
Remarks
See: https://developers.google.com/gdata/docs/resumable_upload for information on the protocol.
Constructors
ResumableUpload(IClientService, string, string, Stream, string)
Create a resumable upload instance with the required parameters.
Declaration
protected ResumableUpload(IClientService service, string path, string httpMethod, Stream contentStream, string contentType)
Parameters
Type | Name | Description |
---|---|---|
IClient |
service | The client service. |
string | path | The path for this media upload method. |
string | httpMethod | The HTTP method to start this upload. |
Stream | contentStream | The stream containing the content to upload. |
string | contentType | Content type of the content to be uploaded. |
Remarks
Considerations regarding contentStream
:
-
If
contentStream
is seekable, then the stream position will be reset to0
before reading commences. IfcontentStream
is not seekable, then it will be read from its current position. -
Caller is responsible for maintaining the
contentStream
open until the upload is completed. -
Caller is responsible for closing the
contentStream
.
Properties
ResponseBody
The response body.
Declaration
public TResponse ResponseBody { get; }
Property Value
Type | Description |
---|---|
TResponse |
Remarks
This property will be set during upload. The Response
Methods
ProcessResponse(HttpResponseMessage)
Process the response body
Declaration
protected override void ProcessResponse(HttpResponseMessage response)
Parameters
Type | Name | Description |
---|---|---|
Http |
response |
Overrides
Events
ResponseReceived
Event which is called when the response metadata is processed.
Declaration
public event Action<TResponse> ResponseReceived
Event Type
Type | Description |
---|---|
Action<TResponse> |