elements_large_object

Large Object

The Large Object 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_large_object
• elements_create_large_object_from_url
• elements_delete_large_object
• elements_get_large_object
• elements_get_large_objects
• elements_update_large_object
• elements_update_large_object_contents

---

Back To Top

elements_create_large_object

Creates a LargeObject

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

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

---

Back To Top

elements_create_large_object_from_url

Creates a LargeObject from provided URL

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

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

---

Back To Top

elements_delete_large_object

Deletes a LargeObject

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_large_object(_large_object_id, _callback=undefined)

Argument	Type	Description
_large_object_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_large_object

Get a LargeObject

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_large_object(_large_object_id, _callback=undefined)

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

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsLargeObject or Undefined
_request	ElementsRequest

---

Back To Top

elements_get_large_objects

Get a LargeObject

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_large_objects(_offset=undefined, _count=undefined, _search=undefined, _callback=undefined)

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

Returns:

N/A

Triggers:

Callback

Key	Type	Description
_status	Real
_data	ElementsPaginationLargeObject or Undefined
_request	ElementsRequest

---

Back To Top

elements_update_large_object

Updates a LargeObject

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

Argument	Type	Description
_large_object_id	String
_body	ElementsUpdateLargeObjectRequest	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	ElementsLargeObject or Undefined
_request	ElementsRequest

---

Back To Top

elements_update_large_object_contents

Updates a LargeObject content

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

Argument	Type	Description
_large_object_id	String
_body	ElementsUpdateLargeObjectContentsBody	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	ElementsLargeObject or Undefined
_request	ElementsRequest

---