elements_save_data

Save Data

The Save Data 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_save_document
• elements_delete_save_document
• elements_get_profile_save_data_document_by_slot
• elements_get_save_data_document
• elements_get_save_data_documents
• elements_get_user_save_data_document_by_slot
• elements_update_save_document

---

Back To Top

elements_create_save_document

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.

Syntax:

elements_create_save_document(_body=undefined, _callback=undefined)

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

---

Back To Top

elements_delete_save_document

Deletes a 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.

Syntax:

elements_delete_save_document(_save_data_document_id, _callback=undefined)

Argument	Type	Description
_save_data_document_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_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.

Syntax:

elements_get_profile_save_data_document_by_slot(_profile_id, _slot, _callback=undefined)

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

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsSaveDataDocument or Undefined
_request	ElementsRequest

---

Back To Top

elements_get_save_data_document

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.

Syntax:

elements_get_save_data_document(_id, _callback=undefined)

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

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsSaveDataDocument or Undefined
_request	ElementsRequest

---

Back To Top

elements_get_save_data_documents

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.

Syntax:

elements_get_save_data_documents(_offset=undefined, _count=undefined, _user_id=undefined, _profile_id=undefined, _search=undefined, _callback=undefined)

Argument	Type	Description
_offset	Real
_count	Real
_user_id	String
_profile_id	String
_search	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationSaveDataDocument or Undefined
_request	ElementsRequest

---

Back To Top

elements_get_user_save_data_document_by_slot

Gets a single save data document based on UserID and slot. This is a convenience method whichallows the client to fetch a save data based on slot an 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.

Syntax:

elements_get_user_save_data_document_by_slot(_user_id, _slot, _callback=undefined)

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

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsSaveDataDocument or Undefined
_request	ElementsRequest

---

Back To Top

elements_update_save_document

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.

Syntax:

elements_update_save_document(_save_data_document_id, _body=undefined, _callback=undefined)

Argument	Type	Description
_save_data_document_id	String
_body	ElementsUpdateSaveDataDocumentRequest	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	ElementsSaveDataDocument or Undefined
_request	ElementsRequest

---