session

Session

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_session_blacklist_session
• elements_session_create_username_password_session
• elements_mock_session_create_mock_session

---

Back To Top

elements_mock_session_create_mock_session

Elements Operation: createMockSession

This function begins a session by accepting a mock session request. The request must be made with an authenticated super-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_mock_session_create_mock_session(_body=undefined, _callback=undefined)

Argument	Type	Description
_body	ElementsMockSessionRequest	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	ElementsMockSessionCreation
_request	ElementsRequest

---

Back To Top

elements_session_blacklist_session

Elements Operation: blacklistSession

This function destroys the Session.

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_session_blacklist_session(_session_secret, _callback=undefined)

Argument	Type	Description
_session_secret	String	The session secret.
_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_session_create_username_password_session

Elements Operation: createUsernamePasswordSession

This function begins a session by accepting both the UserID and the Password. Upon successful completion of this call, the user will be added to the current HTTP session. If the session expires, the user will have to reestablish the session by supplying credentials again. This is most useful for applications delivered in a web page.

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

Argument	Type	Description
_body	ElementsUsernamePasswordSessionRequest	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	ElementsSessionCreation
_request	ElementsRequest