elements_follower

Follower

The Follower 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_follower
• elements_delete_follower
• elements_get_follower
• elements_get_followers

---

Back To Top

elements_create_follower

Supplying the follower object, this will store the information supplied in the body of the request.

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

Argument	Type	Description
_profile_id	String
_body	ElementsCreateFollowerRequest	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	Any
_request	ElementsRequest

---

Back To Top

elements_delete_follower

Deletes a Follower relationship

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

Argument	Type	Description
_profile_id	String
_profile_to_unfollow_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_follower

Gets a specific profile using the ID of the profile and followed 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_follower(_profile_id, _followed_id, _callback=undefined)

Argument	Type	Description
_profile_id	String
_followed_id	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_followers

Searches all followers in the system and returning the metadata for all matches against the given 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_followers(_profile_id, _offset=undefined, _count=undefined, _callback=undefined)

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

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationProfile or Undefined
_request	ElementsRequest

---