ActivityRecord - @magiclane/maps-sdk API Reference

Home > @magiclane/maps-sdk > ActivityRecord

ActivityRecord class

Represents metadata for a recorded activity.

Contains short and long descriptions, the sport type, perceived effort level, an optional bicycle profile for cycling or e-bike activities, and visibility settings that control who can view the activity. Attach an ActivityRecord to a recording (for example via Recorder.activityRecord) to store user-provided metadata about the session.

The ActivityRecord is not detected automatically; it must be explicitly set by the user.

Signature:

export declare class ActivityRecord

Constructors

Constructor	Modifiers	Description
(constructor)(options)		Creates an ActivityRecord with the specified properties. The constructor builds metadata that can be attached to a recording. All parameters are optional and have sensible defaults.

Constructor

Modifiers

Description

(constructor)(options)

Creates an ActivityRecord with the specified properties.

The constructor builds metadata that can be attached to a recording. All parameters are optional and have sensible defaults.

Properties

Property	Type	Description
bikeProfile?	BikeProfileElectricBikeProfile	(Optional) The bicycle profile, if the activity involves cycling. Optional routing and specification details for bicycles and e-bikes.
effortType	EffortType	The effort level for this activity. Indicates the perceived intensity using the EffortType enumeration.
longDescription	string	A detailed description of the activity. Free-form notes or additional context about the activity.
shortDescription	string	A short description of the activity. A concise title or summary suitable for lists or short displays.
sportType	SportType	The type of sport for this activity. Specifies the activity category using the SportType enumeration.
visibility	ActivityVisibility	The visibility settings for the activity. Activities are available only locally, this setting is intended for use by applications.

Methods

Method	Modifiers	Description
fromJson(json)	`static`	Deserializes a JSON-compatible object to create an instance. Used internally, not intended for direct use by consumers. The expected object structure may change without notice.
toJson()		Serializes this instance to a JSON-compatible object. Used internally, not intended for direct use by consumers. The object structure may change without notice.

Method

Modifiers

Description

fromJson(json)

static

Deserializes a JSON-compatible object to create an instance.

Used internally, not intended for direct use by consumers. The expected object structure may change without notice.

toJson()

Serializes this instance to a JSON-compatible object.

Used internally, not intended for direct use by consumers. The object structure may change without notice.