elements_session

Session

The Session 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_blacklist_session
• elements_create_username_password_session

---

Back To Top

elements_blacklist_session

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.

Syntax:

elements_blacklist_session(_session_secret, _callback=undefined)

Argument	Type	Description
_session_secret	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_create_username_password_session

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.

Syntax:

elements_create_username_password_session(_body=undefined, _callback=undefined)

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

---