javastrava.api.v3.rest

Interface UploadAPI

public interface UploadAPI

API definitions for UploadService endpoints

Author:

Dan Shannon

Method Summary

Modifier and Type	Method and Description
StravaUploadResponse	checkUploadStatus(Integer uploadId)
void	checkUploadStatus(Integer uploadId, StravaAPICallback<StravaUploadResponse> callback)
StravaUploadResponse	upload(StravaActivityType activityType, String name, String description, Boolean _private, Boolean trainer, Boolean commute, String dataType, String externalId, retrofit.mime.TypedFile file)
void	upload(StravaActivityType activityType, String name, String description, Boolean _private, Boolean trainer, Boolean commute, String dataType, String externalId, retrofit.mime.TypedFile file, StravaAPICallback<StravaUploadResponse> callback)

Method Detail

checkUploadStatus

@GET(value="/uploads/{id}")
StravaUploadResponse checkUploadStatus(@Path(value="id")
                                                                    Integer uploadId)

Parameters:

uploadId - The upload id as given back in the response to upload(StravaActivityType, String, String, Boolean, Boolean, Boolean, String, String, TypedFile)

Returns:

Upload response containing the upload id and activity id and current status of the upload

See Also:

UploadService.checkUploadStatus(Integer)

checkUploadStatus

@GET(value="/uploads/{id}")
void checkUploadStatus(@Path(value="id")
                                                    Integer uploadId,
                                                    StravaAPICallback<StravaUploadResponse> callback)

Parameters:

uploadId - The upload id as given back in the response to upload(StravaActivityType, String, String, Boolean, Boolean, Boolean, String, String, TypedFile, StravaAPICallback)

callback - The callback to execute on completion

See Also:

UploadService.checkUploadStatus(Integer)

upload

@Multipart
 @POST(value="/uploads")
StravaUploadResponse upload(@Part(value="activity_type")
                                                                  StravaActivityType activityType,
                                                                  @Part(value="name")
                                                                  String name,
                                                                  @Part(value="description")
                                                                  String description,
                                                                  @Part(value="private")
                                                                  Boolean _private,
                                                                  @Part(value="trainer")
                                                                  Boolean trainer,
                                                                  @Part(value="commute")
                                                                  Boolean commute,
                                                                  @Part(value="data_type")
                                                                  String dataType,
                                                                  @Part(value="external_id")
                                                                  String externalId,
                                                                  @Part(value="file")
                                                                  retrofit.mime.TypedFile file)
                                                           throws BadRequestException

Parameters:

activityType - Type of activity being uploaded

name - Name of the activity

description - (Optional) Description of the activity

_private - (Optional) Whether the activity should be flagged as private

trainer - (Optional) If true then the activity was done on a stationary trainer

commute - (Optional) If true then the activity represents a commute

dataType - Type of data file being uploaded

externalId - (Optional) External identifier generated by your application which Strava will later use as a reference when you're checking upload status

file - The file to be uploaded!

Returns:

Upload response containing the upload id and activity id and current status of the upload

Throws:

BadRequestException - If required elements of the call are missing

See Also:

UploadService.upload(StravaActivityType, String, String, Boolean, Boolean, Boolean, String, String, java.io.File)

upload

@Multipart
 @POST(value="/uploads")
void upload(@Part(value="activity_type")
                                                  StravaActivityType activityType,
                                                  @Part(value="name")
                                                  String name,
                                                  @Part(value="description")
                                                  String description,
                                                  @Part(value="private")
                                                  Boolean _private,
                                                  @Part(value="trainer")
                                                  Boolean trainer,
                                                  @Part(value="commute")
                                                  Boolean commute,
                                                  @Part(value="data_type")
                                                  String dataType,
                                                  @Part(value="external_id")
                                                  String externalId,
                                                  @Part(value="file")
                                                  retrofit.mime.TypedFile file,
                                                  StravaAPICallback<StravaUploadResponse> callback)
                                           throws BadRequestException

Parameters:

activityType - Type of activity being uploaded

name - Name of the activity

description - (Optional) Description of the activity

_private - (Optional) Whether the activity should be flagged as private

trainer - (Optional) If true then the activity was done on a stationary trainer

commute - (Optional) If true then the activity represents a commute

dataType - Type of data file being uploaded

externalId - (Optional) External identifier generated by your application which Strava will later use as a reference when you're checking upload status

file - The file to be uploaded!

callback - The callback to execute on completion

Throws:

BadRequestException - If required elements of the call are missing

See Also:

UploadService.upload(StravaActivityType, String, String, Boolean, Boolean, Boolean, String, String, java.io.File)