Search
Preparing search index...
The search index is not available
Keiser Metrics SDK API - v4.15.1
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
Keiser Metrics SDK API - v4.15.1
models/mSeriesChallenge
JoinableMSeriesChallenge
Class JoinableMSeriesChallenge
Hierarchy
MSeriesChallenge
JoinableMSeriesChallenge
Index
Constructors
constructor
Accessors
challenge
Type
end
At
focus
goal
id
is
Completed
is
Joined
is
Public
join
Code
m
Series
Challenge
Data
name
start
At
user
Id
user
Limit
Methods
eject
Data
get
Leaderboard
get
Participant
get
Participants
join
reload
Constructors
constructor
new
JoinableMSeries
Challenge
(
mSeriesChallengeData
:
MSeriesChallengeData
, sessionHandler
:
SessionHandler
)
:
JoinableMSeriesChallenge
Parameters
mSeriesChallengeData:
MSeriesChallengeData
sessionHandler:
SessionHandler
Returns
JoinableMSeriesChallenge
Accessors
challenge
Type
get
challengeType
(
)
:
MSeriesChallengeType
Returns
MSeriesChallengeType
end
At
get
endAt
(
)
:
null
|
Date
Returns
null
|
Date
focus
get
focus
(
)
:
MSeriesChallengeFocus
Returns
MSeriesChallengeFocus
goal
get
goal
(
)
:
number
Returns
number
id
get
id
(
)
:
number
Returns
number
is
Completed
get
isCompleted
(
)
:
boolean
Returns
boolean
is
Joined
get
isJoined
(
)
:
boolean
Returns
boolean
is
Public
get
isPublic
(
)
:
boolean
Returns
boolean
join
Code
get
joinCode
(
)
:
string
Returns
string
m
Series
Challenge
Data
get
mSeriesChallengeData
(
)
:
MSeriesChallengeData
Returns
MSeriesChallengeData
name
get
name
(
)
:
string
Returns
string
start
At
get
startAt
(
)
:
Date
Returns
Date
user
Id
get
userId
(
)
:
number
Returns
number
user
Limit
get
userLimit
(
)
:
null
|
number
Returns
null
|
number
Methods
eject
Data
eject
Data
(
)
:
MSeriesChallengeData
Returns
MSeriesChallengeData
get
Leaderboard
get
Leaderboard
(
options
?:
{
ascending
?:
boolean
;
limit
?:
number
;
offset
?:
number
;
targetUserId
?:
number
}
)
:
Promise
<
MSeriesChallengeLeaderboardParticipants
>
Parameters
options:
{
ascending
?:
boolean
;
limit
?:
number
;
offset
?:
number
;
targetUserId
?:
number
}
= {}
Optional
ascending
?:
boolean
Optional
limit
?:
number
Optional
offset
?:
number
Optional
target
User
Id
?:
number
Returns
Promise
<
MSeriesChallengeLeaderboardParticipants
>
get
Participant
get
Participant
(
params
:
{
mSeriesChallengeParticipantId
:
number
}
)
:
Promise
<
MSeriesChallengeParticipant
>
Parameters
params:
{
mSeriesChallengeParticipantId
:
number
}
m
Series
Challenge
Participant
Id
:
number
Returns
Promise
<
MSeriesChallengeParticipant
>
get
Participants
get
Participants
(
options
:
{
ascending
?:
boolean
;
limit
?:
number
;
nameSearchQuery
:
string
;
offset
?:
number
;
sort
?:
MSeriesChallengeParticipantSorting
}
)
:
Promise
<
MSeriesChallengeParticipants
>
Parameters
options:
{
ascending
?:
boolean
;
limit
?:
number
;
nameSearchQuery
:
string
;
offset
?:
number
;
sort
?:
MSeriesChallengeParticipantSorting
}
Optional
ascending
?:
boolean
Optional
limit
?:
number
name
Search
Query
:
string
Optional
offset
?:
number
Optional
sort
?:
MSeriesChallengeParticipantSorting
Returns
Promise
<
MSeriesChallengeParticipants
>
join
join
(
)
:
Promise
<
{
joinedMSeriesChallenge
:
JoinedMSeriesChallenge
;
mSeriesChallengeParticipant
:
MSeriesChallengeParticipant
}
>
Returns
Promise
<
{
joinedMSeriesChallenge
:
JoinedMSeriesChallenge
;
mSeriesChallengeParticipant
:
MSeriesChallengeParticipant
}
>
reload
reload
(
)
:
Promise
<
JoinableMSeriesChallenge
>
Returns
Promise
<
JoinableMSeriesChallenge
>
Modules
models/m
Series
Challenge
MSeries
Challenge
Focus
MSeries
Challenge
Relationship
MSeries
Challenge
Sorting
MSeries
Challenge
Type
JoinableMSeries
Challenge
constructor
challenge
Type
end
At
focus
goal
id
is
Completed
is
Joined
is
Public
join
Code
m
Series
Challenge
Data
name
start
At
user
Id
user
Limit
eject
Data
get
Leaderboard
get
Participant
get
Participants
join
reload
JoinableMSeries
Challenges
JoinedMSeries
Challenge
JoinedMSeries
Challenges
MSeries
Challenge
PrivilegedMSeries
Challenge
PrivilegedMSeries
Challenges
MSeries
Challenge
Data
MSeries
Challenge
List
Response
MSeries
Challenge
List
Response
Meta
MSeries
Challenge
Response