elements_progress

Progress

The Progress endpoints.

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_create_progress
• elements_delete_progress
• elements_get_progress_by_name_or_id
• elements_get_progress_tabular
• elements_update_progress

---

Back To Top

elements_create_progress

This will create a new progress with a compound id of the profile and mission. 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.

Syntax:

elements_create_progress(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateProgressRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsProgress or Undefined
_request	ElementsRequest

---

Back To Top

elements_delete_progress

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.

Syntax:

elements_delete_progress(_progress_id, _callback=undefined)

Argument	Type	Description
_progress_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	ElementsRequest

---

Back To Top

elements_get_progress_by_name_or_id

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.

Syntax:

elements_get_progress_by_name_or_id(_progress_id, _callback=undefined)

Argument	Type	Description
_progress_id	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsProgress or Undefined
_request	ElementsRequest

---

Back To Top

elements_get_progress_tabular

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.

Syntax:

elements_get_progress_tabular(_callback=undefined)

Argument	Type	Description
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	Any
_request	ElementsRequest

---

Back To Top

elements_update_progress

This 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.

Syntax:

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

Argument	Type	Description
_progress_id	String
_body	ElementsUpdateProgressRequest	The body to be included in the http request.
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsProgress or Undefined
_request	ElementsRequest

---