Links
🗂

Get Collections

Use this method to get metadata of multiple collections at the same time.

Usage in your script

GetCollections
.Initialize(destroyAtEnd: true)
.SetParameters(
perPage: "20",
page: "1",
sortBy: "name",
sortDir: "asc"
)
.AlturaOptions(isVerified: "true")
.OnError(error => Debug.Log(error))
.OnComplete(result => Debug.Log(result))
.Run();

Member Functions

.Initialize()
Parameter
Type
Required
Description
destroyAtEnd
bool
Optional
defines if this component will be destroyed after .Run()
.SetParameters()
Parameter
Type
Required
Description
perPage
String
Optional
The number of collections to return
page
String
Optional
The offset for returned collections. Calculated as (page - 1) * perPage
sortBy
String
Optional
The field to sort the collections by (any field in the collection schema may be used)
sortDir
String
Optional
Choose to sort in ascending (asc) or descending (desc) order
.AlturaOptions()
Get only verified collection
.onError()
Action on Error: returns error information.
.onComplete()
Action on successful: returns Auth_model type.
.Run()
Runs the API call and fills the corresponding model in the component on success.