UserSession | Keiser Metrics SDK API

Hierarchy

UserSessionBase<User>
- UserSession

Index

Constructors

constructor

Accessors

Constructors

constructor

new UserSession(userResponse: UserResponse, connection: MetricsConnection): UserSession

Overrides UserSessionBase.constructor
- Defined in src/session.ts:738
Parameters
- userResponse: UserResponse
- connection: MetricsConnection
Returns UserSession

Accessors

accessToken

get accessToken(): string

- Defined in src/session.ts:583
Returns string

keepAlive

get keepAlive(): boolean
set keepAlive(value: boolean): void

- Defined in src/session.ts:575
Returns boolean
- Defined in src/session.ts:579
Parameters
- value: boolean
Returns void

onAccessTokenChangeEvent

get onAccessTokenChangeEvent(): IEvent<AccessTokenChangeEvent>

- Defined in src/session.ts:587
Returns IEvent<AccessTokenChangeEvent>

onRefreshTokenChangeEvent

get onRefreshTokenChangeEvent(): IEvent<RefreshTokenChangeEvent>

- Defined in src/session.ts:595
Returns IEvent<RefreshTokenChangeEvent>

refreshToken

get refreshToken(): null | string

- Defined in src/session.ts:591
Returns null | string

sessionHandler

get sessionHandler(): SessionHandler

- Defined in src/session.ts:571
Returns SessionHandler

user

get user(): UserType

- Defined in src/session.ts:607
Returns UserType

Methods

close

close(): void

Inherited from UserSessionBase.close
- Defined in src/session.ts:599
Returns void

eagerActiveFacility

eagerActiveFacility(): undefined | PrivilegedFacility

Inherited from UserSessionBase.eagerActiveFacility
- Defined in src/session.ts:611
Returns undefined | PrivilegedFacility

getCardioExercise

getCardioExercise(params: { id: number }): Promise<CardioExercise>

Inherited from UserSessionBase.getCardioExercise
- Defined in src/session.ts:694
Parameters
- params: { id: number }
  - id: number
Returns Promise<CardioExercise>

getCardioExerciseMuscle

getCardioExerciseMuscle(params: { id: number }): Promise<CardioExerciseMuscle>

Inherited from UserSessionBase.getCardioExerciseMuscle
- Defined in src/session.ts:719
Parameters
- params: { id: number }
  - id: number
Returns Promise<CardioExerciseMuscle>

getCardioExerciseVariant

getCardioExerciseVariant(params: { id: number }): Promise<CardioExerciseVariant>

Inherited from UserSessionBase.getCardioExerciseVariant
- Defined in src/session.ts:714
Parameters
- params: { id: number }
  - id: number
Returns Promise<CardioExerciseVariant>

getCardioExercises

getCardioExercises(options?: { ascending?: boolean; defaultAlias?: string; limit?: number; offset?: number; sort?: CardioExerciseSorting }): Promise<CardioExercises>

Inherited from UserSessionBase.getCardioExercises
- Defined in src/session.ts:699
Parameters
- options: { ascending?: boolean; defaultAlias?: string; limit?: number; offset?: number; sort?: CardioExerciseSorting } = {}
  - Optional ascending?: boolean
  - Optional defaultAlias?: string
  - Optional limit?: number
  - Optional offset?: number
  - Optional sort?: CardioExerciseSorting
Returns Promise<CardioExercises>

getCardioMachine

getCardioMachine(params: { id: number }): Promise<CardioMachine>

Inherited from UserSessionBase.getCardioMachine
- Defined in src/session.ts:704
Parameters
- params: { id: number }
  - id: number
Returns Promise<CardioMachine>

getCardioMachines

getCardioMachines(options?: { ascending?: boolean; limit?: number; name?: string; offset?: number; sort?: CardioMachineSorting }): Promise<CardioMachines>

Inherited from UserSessionBase.getCardioMachines
- Defined in src/session.ts:709
Parameters
- options: { ascending?: boolean; limit?: number; name?: string; offset?: number; sort?: CardioMachineSorting } = {}
  - Optional ascending?: boolean
  - Optional limit?: number
  - Optional name?: string
  - Optional offset?: number
  - Optional sort?: CardioMachineSorting
Returns Promise<CardioMachines>

getExerciseAlias

getExerciseAlias(params: { id: number }): Promise<ExerciseAlias>

Inherited from UserSessionBase.getExerciseAlias
- Defined in src/session.ts:619
Parameters
- params: { id: number }
  - id: number
Returns Promise<ExerciseAlias>

getExerciseAliases

getExerciseAliases(options?: { alias?: string; ascending?: boolean; limit?: number; offset?: number; sort?: ExerciseAliasSorting; type?: ExerciseAliasType }): Promise<ExerciseAliases>

Inherited from UserSessionBase.getExerciseAliases
- Defined in src/session.ts:624
Parameters
- options: { alias?: string; ascending?: boolean; limit?: number; offset?: number; sort?: ExerciseAliasSorting; type?: ExerciseAliasType } = {}
  - Optional alias?: string
  - Optional ascending?: boolean
  - Optional limit?: number
  - Optional offset?: number
  - Optional sort?: ExerciseAliasSorting
  - Optional type?: ExerciseAliasType
Returns Promise<ExerciseAliases>

getExerciseOrdinalSet

getExerciseOrdinalSet(params: { id: number }): Promise<ExerciseOrdinalSet>

Inherited from UserSessionBase.getExerciseOrdinalSet
- Defined in src/session.ts:634
Parameters
- params: { id: number }
  - id: number
Returns Promise<ExerciseOrdinalSet>

getExerciseOrdinalSetAssignment

getExerciseOrdinalSetAssignment(params: { id: number }): Promise<ExerciseOrdinalSetAssignment>

Inherited from UserSessionBase.getExerciseOrdinalSetAssignment
- Defined in src/session.ts:629
Parameters
- params: { id: number }
  - id: number
Returns Promise<ExerciseOrdinalSetAssignment>

getExerciseOrdinalSets

getExerciseOrdinalSets(options?: { ascending?: boolean; code?: string; limit?: number; name?: string; offset?: number; sort?: ExerciseOrdinalSetSorting }): Promise<ExerciseOrdinalSets>

Inherited from UserSessionBase.getExerciseOrdinalSets
- Defined in src/session.ts:639
Parameters
- options: { ascending?: boolean; code?: string; limit?: number; name?: string; offset?: number; sort?: ExerciseOrdinalSetSorting } = {}
  - Optional ascending?: boolean
  - Optional code?: string
  - Optional limit?: number
  - Optional name?: string
  - Optional offset?: number
  - Optional sort?: ExerciseOrdinalSetSorting
Returns Promise<ExerciseOrdinalSets>

getFacilities

getFacilities(options?: { address?: string; ascending?: boolean; city?: string; country?: string; limit?: number; name?: string; offset?: number; phone?: string; postcode?: string; sort?: FacilitySorting; state?: string }): Promise<Facilities>

Inherited from UserSessionBase.getFacilities
- Defined in src/session.ts:729
Parameters
- options: { address?: string; ascending?: boolean; city?: string; country?: string; limit?: number; name?: string; offset?: number; phone?: string; postcode?: string; sort?: FacilitySorting; state?: string } = {}
  - Optional address?: string
  - Optional ascending?: boolean
  - Optional city?: string
  - Optional country?: string
  - Optional limit?: number
  - Optional name?: string
  - Optional offset?: number
  - Optional phone?: string
  - Optional postcode?: string
  - Optional sort?: FacilitySorting
  - Optional state?: string
Returns Promise<Facilities>

getFacility

getFacility(params: { id: number }): Promise<Facility<SessionHandler>>

Inherited from UserSessionBase.getFacility
- Defined in src/session.ts:724
Parameters
- params: { id: number }
  - id: number
Returns Promise<Facility<SessionHandler>>

getStrengthExercise

getStrengthExercise(params: { id: number }): Promise<StrengthExercise>

Inherited from UserSessionBase.getStrengthExercise
- Defined in src/session.ts:644
Parameters
- params: { id: number }
  - id: number
Returns Promise<StrengthExercise>

getStrengthExerciseMuscle

getStrengthExerciseMuscle(params: { id: number }): Promise<StrengthExerciseMuscle>

Inherited from UserSessionBase.getStrengthExerciseMuscle
- Defined in src/session.ts:669
Parameters
- params: { id: number }
  - id: number
Returns Promise<StrengthExerciseMuscle>

getStrengthExerciseVariant

getStrengthExerciseVariant(params: { id: number }): Promise<StrengthExerciseVariant>

Inherited from UserSessionBase.getStrengthExerciseVariant
- Defined in src/session.ts:664
Parameters
- params: { id: number }
  - id: number
Returns Promise<StrengthExerciseVariant>

getStrengthExercises

getStrengthExercises(options?: { ascending?: boolean; category?: StrengthExerciseCategory; defaultAlias?: string; humahMovement?: StrengthExerciseMovement; limit?: number; movement?: StrengthExerciseMovementDEP; offset?: number; plane?: StrengthExercisePlane; sort?: StrengthExerciseSorting }): Promise<StrengthExercises>

Inherited from UserSessionBase.getStrengthExercises
- Defined in src/session.ts:649
Parameters
- options: { ascending?: boolean; category?: StrengthExerciseCategory; defaultAlias?: string; humahMovement?: StrengthExerciseMovement; limit?: number; movement?: StrengthExerciseMovementDEP; offset?: number; plane?: StrengthExercisePlane; sort?: StrengthExerciseSorting } = {}
  - Optional ascending?: boolean
  - Optional category?: StrengthExerciseCategory
  - Optional defaultAlias?: string
  - Optional humahMovement?: StrengthExerciseMovement
  - Optional limit?: number
  - Optional movement?: StrengthExerciseMovementDEP
  - Optional offset?: number
  - Optional plane?: StrengthExercisePlane
  - Optional sort?: StrengthExerciseSorting
Returns Promise<StrengthExercises>

getStrengthMachine

getStrengthMachine(params: { id: number }): Promise<StrengthMachine>

Inherited from UserSessionBase.getStrengthMachine
- Defined in src/session.ts:654
Parameters
- params: { id: number }
  - id: number
Returns Promise<StrengthMachine>

getStrengthMachines

getStrengthMachines(options?: { ascending?: boolean; limit?: number; line?: string; name?: string; offset?: number; sort?: StrengthMachineSorting; variant?: string }): Promise<StrengthMachines>

Inherited from UserSessionBase.getStrengthMachines
- Defined in src/session.ts:659
Parameters
- options: { ascending?: boolean; limit?: number; line?: string; name?: string; offset?: number; sort?: StrengthMachineSorting; variant?: string } = {}
  - Optional ascending?: boolean
  - Optional limit?: number
  - Optional line?: string
  - Optional name?: string
  - Optional offset?: number
  - Optional sort?: StrengthMachineSorting
  - Optional variant?: string
Returns Promise<StrengthMachines>

getStretchExercise

getStretchExercise(params: { id: number }): Promise<StretchExercise>

Inherited from UserSessionBase.getStretchExercise
- Defined in src/session.ts:674
Parameters
- params: { id: number }
  - id: number
Returns Promise<StretchExercise>

getStretchExerciseMuscle

getStretchExerciseMuscle(params: { id: number }): Promise<StretchExerciseMuscle>

Inherited from UserSessionBase.getStretchExerciseMuscle
- Defined in src/session.ts:689
Parameters
- params: { id: number }
  - id: number
Returns Promise<StretchExerciseMuscle>

getStretchExerciseVariant

getStretchExerciseVariant(params: { id: number }): Promise<StretchExerciseVariant>

Inherited from UserSessionBase.getStretchExerciseVariant
- Defined in src/session.ts:684
Parameters
- params: { id: number }
  - id: number
Returns Promise<StretchExerciseVariant>

getStretchExercises

getStretchExercises(options?: { ascending?: boolean; imageUri?: string; instructionalVideoUri?: string; limit?: number; offset?: number; sort?: StretchExerciseSorting }): Promise<StretchExercises>

Inherited from UserSessionBase.getStretchExercises
- Defined in src/session.ts:679
Parameters
- options: { ascending?: boolean; imageUri?: string; instructionalVideoUri?: string; limit?: number; offset?: number; sort?: StretchExerciseSorting } = {}
  - Optional ascending?: boolean
  - Optional imageUri?: string
  - Optional instructionalVideoUri?: string
  - Optional limit?: number
  - Optional offset?: number
  - Optional sort?: StretchExerciseSorting
Returns Promise<StretchExercises>

logout

logout(): Promise<void>

Inherited from UserSessionBase.logout
- Defined in src/session.ts:603
Returns Promise<void>

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

userResponse: UserResponse

connection: MetricsConnection

Returns UserSession

Accessors

accessToken

Returns string

keepAlive

Returns boolean

Parameters

value: boolean

Returns void

onAccessTokenChangeEvent

Returns IEvent<AccessTokenChangeEvent>

onRefreshTokenChangeEvent

Returns IEvent<RefreshTokenChangeEvent>

refreshToken

Returns null | string

sessionHandler

Returns SessionHandler

user

Returns UserType

Methods

close

Returns void

eagerActiveFacility

Returns undefined | PrivilegedFacility

getCardioExercise

Parameters

params: { id: number }

id: number

Returns Promise<CardioExercise>

getCardioExerciseMuscle

Parameters

params: { id: number }

id: number

Returns Promise<CardioExerciseMuscle>

getCardioExerciseVariant

Parameters

params: { id: number }

id: number

Returns Promise<CardioExerciseVariant>

getCardioExercises

Parameters

options: { ascending?: boolean; defaultAlias?: string; limit?: number; offset?: number; sort?: CardioExerciseSorting } = {}

Optional ascending?: boolean

Optional defaultAlias?: string

Optional limit?: number

Optional offset?: number

Optional sort?: CardioExerciseSorting

Returns Promise<CardioExercises>

getCardioMachine

Parameters

params: { id: number }

id: number

Returns Promise<CardioMachine>

getCardioMachines

Parameters

options: { ascending?: boolean; limit?: number; name?: string; offset?: number; sort?: CardioMachineSorting } = {}

Optional ascending?: boolean

Optional limit?: number

Optional name?: string

Optional offset?: number

Optional sort?: CardioMachineSorting

Returns Promise<CardioMachines>

getExerciseAlias

Parameters

params: { id: number }

id: number

Returns Promise<ExerciseAlias>

getExerciseAliases

Parameters

options: { alias?: string; ascending?: boolean; limit?: number; offset?: number; sort?: ExerciseAliasSorting; type?: ExerciseAliasType } = {}