Class UsersResource.DataTypesResource.DataPointsResource.ExportExerciseTcxRequest

Exports exercise data in TCX format. Note: While the Authorization section below states that any one of the listed scopes is accepted, this specific method requires the user to provide both one of the activity_and_fitness scopes (normal or readonly) AND one of the location scopes (normal or readonly) in their access token to succeed.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<ExportExerciseTcxResponse>
GoogleHealthAPIBaseServiceRequest<ExportExerciseTcxResponse>
UsersResource.DataTypesResource.DataPointsResource.ExportExerciseTcxRequest
Implements
Inherited Members
Namespace: Google.Apis.GoogleHealthAPI.v4
Assembly: Google.Apis.GoogleHealthAPI.v4.dll
Syntax
public class UsersResource.DataTypesResource.DataPointsResource.ExportExerciseTcxRequest : GoogleHealthAPIBaseServiceRequest<ExportExerciseTcxResponse>, IClientServiceRequest<ExportExerciseTcxResponse>, IClientServiceRequest

Constructors

ExportExerciseTcxRequest(IClientService, string)

Constructs a new ExportExerciseTcx request.

Declaration
public ExportExerciseTcxRequest(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

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

Name

Required. The resource name of the exercise data point to export. Format: users/{user}/dataTypes/exercise/dataPoints/{data_point} Example: users/me/dataTypes/exercise/dataPoints/2026443605080188808 The {user} is the alias "me" currently. Future versions may support user IDs. The {data_point} ID maps to the exercise ID, which is a long integer.

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

PartialData

Optional. Indicates whether to include the TCX data points when the GPS data is not available. If not specified, defaults to false and partial data will not be included.

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

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 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 ExportExerciseTcx parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements