elements_profile

Profile

The Profile 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_profile
• elements_deactivate_profile
• elements_get_current_profile
• elements_get_profile
• elements_get_profiles
• elements_update_profile
• elements_update_profile_image

---

Back To Top

elements_create_profile

Supplying the create profile request, this will update the profile with the new information supplied in the body of the request. This will fire an event, dev.getelements.elements.service.profile.created, from the event manifest.

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

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

---

Back To Top

elements_deactivate_profile

Deletes and permanently removes the Profile from the server. The server maykeep some record around to preserve relationships and references, but this profile will not be accessible again until it is recreated.

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

Argument	Type	Description
_profile_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_current_profile

This is a special endpoing which fetches the current Profile based on current auth credentials. This considers the currently loggged-in Dser as well as the Application or Application Configuration against which the User is operating. This may not be availble, in which case the appopraite error is rasied.

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_current_profile(_callback=undefined)

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

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsProfile or Undefined
_request	ElementsRequest

---

Back To Top

elements_get_profile

Gets a specific profile by 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(_name, _callback=undefined)

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

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsProfile or Undefined
_request	ElementsRequest

---

Back To Top

elements_get_profiles

Searches all users in the system and returning the metadata for all matches against the given search filter. Optionally provide before and after params to specify a time range [after, before] for last-logged-in profiles matching in that range (inclusive). If before is not specified (or a negative number is provided) but after is valid, the query will return all records successive to the given after timestamp. Similarly, if after is not specified (or a negative number is provided) but before is valid, the query will return all records preceding the given before timestamp. Note that search and time range parameters currently cannot be combined in the same query.

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_profiles(_offset=undefined, _count=undefined, _before=undefined, _after=undefined, _application=undefined, _user=undefined, _search=undefined, _callback=undefined)

Argument	Type	Description
_offset	Real
_count	Real
_before	Real
_after	Real
_application	String
_user	String
_search	String
_callback	Function	Callback with signature (status, data, request).

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationProfile or Undefined
_request	ElementsRequest

---

Back To Top

elements_update_profile

Supplying an update request will attempt to update the profile. The call will return the profile as it was written to the database.

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

Argument	Type	Description
_profile_id	String
_body	ElementsUpdateProfileRequest	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	ElementsProfile or Undefined
_request	ElementsRequest

---

Back To Top

elements_update_profile_image

Updates a Profile image object

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

Argument	Type	Description
_profile_id	String
_body	ElementsUpdateProfileImageRequest	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	ElementsProfile or Undefined
_request	ElementsRequest

---