UPWorkoutAPI Class Reference

Inherits from	NSObject
Declared in	UPWorkoutAPI.h UPWorkoutAPI.m

Overview

Provides an interface for interacting with the user’s workouts.

Tasks

+ getWorkoutsWithLimit:completion:
+ getWorkoutsFromStartDate:toEndDate:completion:
+ postWorkout:completion:
+ refreshWorkout:completion:
+ deleteWorkout:completion:
+ getWorkoutGraphImage:completion:
+ getWorkoutTicks:completion:

Class Methods

deleteWorkout:completion:

Delete an existing workout event. The event must belong to the currently authenticated user.

+ (void)deleteWorkout:(UPWorkout *)workout completion:(UPBaseEventAPICompletion)completion

Parameters

workout: The existing workout event to be deleted.

completion: Block to be executed upon completion.

Discussion

Delete an existing workout event. The event must belong to the currently authenticated user.

Declared In

UPWorkoutAPI.h

getWorkoutGraphImage:completion:

Request the graph image for the workout event.

+ (void)getWorkoutGraphImage:(UPWorkout *)workout completion:(UPBaseEventAPIImageCompletion)completion

Parameters

workout: The workout for which to request the graph.

completion: Block to be executed upon completion. The block is passed the result image.

Discussion

Request the graph image for the workout event.

Declared In

UPWorkoutAPI.h

getWorkoutTicks:completion:

Requests individual ticks in the workout. Ticks have finer grain detail about the move.

+ (void)getWorkoutTicks:(UPWorkout *)workout completion:(UPBaseEventAPIArrayCompletion)completion

Parameters

workout: The workout for which to request the ticks.

completion: Block to be executed upon completion. The block is passed the array of ticks.

Discussion

Requests individual ticks in the workout. Ticks have finer grain detail about the move.

Declared In

UPWorkoutAPI.h

getWorkoutsFromStartDate:toEndDate:completion:

Request workout events between two points in time for the currently authenticated user.

+ (void)getWorkoutsFromStartDate:(NSDate *)startDate toEndDate:(NSDate *)endDate completion:(UPBaseEventAPIArrayCompletion)completion

Parameters

startDate: Request workout events after this date. The date must be in the past.

endDate: Request workout events before this date. The date must be in the past.

completion: Block to be executed upon completion. The block is passed the results.

Discussion

Request workout events between two points in time for the currently authenticated user.

Declared In

UPWorkoutAPI.h

getWorkoutsWithLimit:completion:

Request recent workout events for the currently authenticated user.

+ (void)getWorkoutsWithLimit:(NSUInteger)limit completion:(UPBaseEventAPIArrayCompletion)completion

Parameters

limit: The maximum number of workout events to be returned.

completion: Block to be executed upon completion. The block is passed the results.

Discussion

Request recent workout events for the currently authenticated user.

Declared In

UPWorkoutAPI.h

postWorkout:completion:

Post a new workout event to the feed of the currently authenticated user.

+ (void)postWorkout:(UPWorkout *)workout completion:(UPWorkoutAPICompletion)completion

Parameters

workout: A new workout event to be added to the feed.

completion: Block to be executed upon request completion.

Discussion

Post a new workout event to the feed of the currently authenticated user.

Declared In

UPWorkoutAPI.h

refreshWorkout:completion:

Request an existing workout event. The event must be visible to the currently authenticated user.

+ (void)refreshWorkout:(UPWorkout *)workout completion:(UPWorkoutAPICompletion)completion

Parameters

workout: An existing workout event.

completion: Block to be executed upon completion. The block is passed the result.

Discussion

Request an existing workout event. The event must be visible to the currently authenticated user.

Declared In

UPWorkoutAPI.h