progress

Progress

Functions

This module offers a collection of functions designed to address specific tasks and provide utilities for various purposes. Explore the available functions to make the most of the functionalities provided by this module.

• elements_progress_get_progress_tabular
• elements_progress_create_progress
• elements_progress_delete_progress
• elements_progress_get_progress_by_name_or_id
• elements_progress_update_progress

---

Back To Top

elements_progress_get_progress_tabular

Elements Operation: getProgressTabular

This function gets the current Profile's rank among all players for the particular leaderboard.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback Function.

Syntax:

elements_progress_get_progress_tabular(_callback=undefined)

Argument	Type	Description
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

N/A

Triggers:

Callback Function

Key	Type	Description
_status	Real
_data	Undefined
_request	ElementsRequest

---

Back To Top

elements_progress_create_progress

Elements Operation: createProgress

Supplying a progress object, this function will create a new progress with a newly assigned unique ID. The Progress representation returned in the response body is a representation of the Progress as persisted with a unique identifier assigned and with its fields properly normalized.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback Function.

Syntax:

elements_progress_create_progress(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsProgress	The body to be included in the HTTP request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

N/A

Triggers:

Callback Function

Key	Type	Description
_status	Real
_data	ElementsProgress
_request	ElementsRequest

---

Back To Top

elements_progress_delete_progress

Elements Operation: deleteProgress

This function deletes a progress by the passed in identifier.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback Function.

Syntax:

elements_progress_delete_progress(_progress_id, _callback=undefined)

Argument	Type	Description
_progress_id	String	The ID of the progress.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

N/A

Triggers:

Callback Function

Key	Type	Description
_status	Real
_data	Undefined
_request	ElementsRequest

---

Back To Top

elements_progress_get_progress_by_name_or_id

Elements Operation: getProgressByNameOrId

This function looks up a progress by the passed in identifier.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback Function.

Syntax:

elements_progress_get_progress_by_name_or_id(_progress_id, _callback=undefined)

Argument	Type	Description
_progress_id	String	The ID of the progress.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

N/A

Triggers:

Callback Function

Key	Type	Description
_status	Real
_data	ElementsProgress
_request	ElementsRequest

---

Back To Top

elements_progress_update_progress

Elements Operation: updateProgress

Supplying a progress, this function will update the Progress identified by the ID in the path with contents from the passed in request body.

This function operates asynchronously, which means that it does not immediately return the requested result. Instead, upon completion of the task, it will trigger the Callback Function.

Syntax:

elements_progress_update_progress(_progress_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_progress_id	String	The ID of the progress.
_body	ElementsProgress	The body to be included in the HTTP request.
_callback	Function	The function - with signature (status, data, request) - that will be executed upon request completion.

Returns:

N/A

Triggers:

Callback Function

Key	Type	Description
_status	Real
_data	ElementsProgress
_request	ElementsRequest