save_data

Save Data

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_save_data_get_save_data_documents
• elements_save_data_create_save_document
• elements_save_data_update_save_document
• elements_save_data_delete_save_document
• elements_save_data_get_save_data_document
• elements_save_data_get_user_save_data_document_by_slot
• elements_save_data_get_profile_save_data_document_by_slot

---

Back To Top

elements_save_data_get_save_data_documents

Elements Operation: getSaveDataDocuments

This function gets all save data documents available to the user.

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_save_data_get_save_data_documents(_offset=undefined, _count=undefined, _user_id=undefined, _profile_id=undefined, _search=undefined, _callback=undefined)

Argument	Type	Description
_offset	Real	The offset of the first result to return in the page.
_count	Real	The number of results to return in the page.
_user_id	String	The User ID.
_profile_id	String	The Profile ID.
_search	String	The search filter to use.
_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	ElementsPaginationSaveDataDocument
_request	ElementsRequest

---

Back To Top

elements_save_data_create_save_document

Elements Operation: createSaveDocument

This function gets a single save data document.

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_save_data_create_save_document(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsCreateSaveDataDocumentRequest	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	ElementsSaveDataDocument
_request	ElementsRequest

---

Back To Top

elements_save_data_update_save_document

Elements Operation: updateSaveDocument

This function gets a single save data document.

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_save_data_update_save_document(_save_data_document_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_save_data_document_id	String	The ID of the save data document.
_body	ElementsUpdateSaveDataDocumentRequest	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	ElementsSaveDataDocument
_request	ElementsRequest

---

Back To Top

elements_save_data_delete_save_document

Elements Operation: deleteSaveDocument

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_save_data_delete_save_document(_save_data_document_id, _callback=undefined)

Argument	Type	Description
_save_data_document_id	String	The ID of the save data document.
_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_save_data_get_save_data_document

Elements Operation: getSaveDataDocument

This function gets a single save data document.

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_save_data_get_save_data_document(_id, _callback=undefined)

Argument	Type	Description
_id	String	The ID of the save data document.
_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	ElementsSaveDataDocument
_request	ElementsRequest

---

Back To Top

elements_save_data_get_user_save_data_document_by_slot

Elements Operation: getUserSaveDataDocumentBySlot

This function gets a single save data document based on UserID and slot. This is a convenience method which allows the client to fetch a save data based on slot and user ID.

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_save_data_get_user_save_data_document_by_slot(_user_id, _slot, _callback=undefined)

Argument	Type	Description
_user_id	String	The User ID.
_slot	Real	The slot.
_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	ElementsSaveDataDocument
_request	ElementsRequest

---

Back To Top

elements_save_data_get_profile_save_data_document_by_slot

Gets a single save data document based on Profile ID and slot. This is a convenience method whichallows the client to fetch a save data based on slot an profile id.

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_save_data_get_profile_save_data_document_by_slot(_profile_id, _slot, _callback=undefined)

Argument	Type	Description
_profile_id	String
_slot	Real
_callback	Function	The function - with signature (status: Real, data: ${Struct.ElementsSaveDataDocument}, request: ${Struct.ElementsRequest}) - that will be executed upon request completion.

Returns:

N/A

Triggers:

Callback Function

Key	Type	Description
_status	Real
_data	ElementsSaveDataDocument
_request	ElementsRequest