api

Documentation

Overview

Package api implements Runtastic API for downloading activity data.

Index

• type Activity
• type ActivityID
• type DataPoint
• type Metadata
• type Options
• type Session
  • func Login(ctx context.Context, email, password string) (*Session, error)
  • func (session *Session) GetActivities(ctx context.Context) ([]Activity, error)
  • func (session *Session) GetActivity(ctx context.Context, id ActivityID) (*Activity, error)
  • func (session *Session) GetMetadata(ctx context.Context) ([]Metadata, error)

Types

type Activity

type Activity struct {
	Metadata
	Data []DataPoint
}

Activity contains metadata and collection of data points for single activity.

type ActivityID

type ActivityID string

ActivityID is unique activity identifier.

type DataPoint

type DataPoint struct {
	Longitude float32
	Latitude  float32
	Elevation float32
	Time      time.Time
	Distance  int32
	HeartRate uint8
}

DataPoint represents single activity data point.

type Metadata

type Metadata struct {
	ID            ActivityID
	Type          string
	StartTime     time.Time
	EndTime       time.Time
	Calories      int32
	Distance      int32
	Duration      time.Duration
	AvgHeartRate  int32
	MaxHeartReate int32
	Notes         string
}

Metadata represents high-level overview of the single activity.

type Options

type Options struct {
	Tolerance int
}

Options contain parameters that configure how data traces are retrieved and merged.

type Session

type Session struct {
	Options Options
	// contains filtered or unexported fields
}

Session contains session data for single authenticated user.

func Login

func Login(ctx context.Context, email, password string) (*Session, error)

Login connects to Runtastic API server and authenticates user using given email and password.

func (*Session) GetActivities

func (session *Session) GetActivities(ctx context.Context) ([]Activity, error)

GetActivities retrieves metadata and traces for all available activities.

func (*Session) GetActivity

func (session *Session) GetActivity(ctx context.Context, id ActivityID) (*Activity, error)

GetActivity downloads GPS trace and heart rate data of an activity with given ID.

func (*Session) GetMetadata

func (session *Session) GetMetadata(ctx context.Context) ([]Metadata, error)

GetMetadata returns list of metadata of all available activities.