Home Manual Reference Source
public class | source

Progress

Progress object for challenges. Progress keeps track of the total challenges in a category and the amount of SpeechChallenges that are completed.

Constructor Summary

Public Constructor
public

constructor(user: Object, category: string, percentage: string, challenges: Array<Object>)

Create a Progress object.

Member Summary

Public Members
public
public
public
public

Public Constructors

public constructor(user: Object, category: string, percentage: string, challenges: Array<Object>) source

Create a Progress object.

Params:

NameTypeAttributeDescription
user Object

Some user information that belongs to the progress.

category string

The category identifier to which this progress object refers.

percentage string
  • nullable: true

The percentage of completeness of all (underlying) challenges.

challenges Array<Object>
  • nullable: true

Challenges belonging to the progress.

Throw:

Error

user parameter of type "Object" is required

Error

category parameter of type "string" is required

Error

percentage parameter of type "string|null" is required

Error

challenges parameter of type "Array.<Objects>|null" is required

Public Members

public category: string source

public challenges: Object source

public percentage: string | null source

public user: Object source