Skip to content

Commit 42b4625

Browse files
sinokgrsinokgr
authored
Added the rest of the documentation
Added the remaining functions.
1 parent b863982 commit 42b4625

1 file changed

Lines changed: 50 additions & 0 deletions

File tree

‎docs/Collections_API.md‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,4 +75,54 @@ create a new dynamic collections given a name, a type and a storage mode
7575

7676
move the 'name' collection to the 'new_name' parent
7777

78+
### add_to_collection(name, ECollectionShareType, objectPath)
7879

80+
add an asset to a static collection using asset's path
81+
82+
### collection_exists(name, ECollectionShareType)
83+
84+
Returns true if a collection already exists
85+
86+
### create_unique_collection_name(name, ECollectionShareType)
87+
88+
returns a string with a unique collection name
89+
90+
### destroy_collection(name, ECollectionShareType)
91+
92+
deletes an existing collection and returns true on success and false on failure
93+
94+
### empty_collection(name, ECollectionShareType)
95+
96+
removes all the existing assets from a collection. Returns true on success and false on failure
97+
98+
### get_dynamic_query_text(name, ECollectionShareType)
99+
100+
returns the search text from a dynamic collection. If you use it on a static collection you will get an error
101+
102+
### set_dynamic_query_text(name, ECollectionShareType, searchText)
103+
104+
sets the search text to a dynamic collection. Returns true on success and false on failure
105+
106+
### remove_from_collection(name, ECollectionShareType, objectPath)
107+
108+
removes an asset from a static collection using asset's path. Returns true on success and false on failure
109+
110+
### get_assets_in_collection(name, ECollectionShareType, recursion(optional))
111+
112+
returns a list with all the asset paths. There is a third optional parameter for recursion. Default value is 1. This function works only with static collections
113+
114+
### get_objects_in_collection(name, ECollectionShareType, recursion(optional))
115+
116+
returns a list with all the object paths. There is a third optional parameter for recursion. Default value is 1. This function works only with static collections
117+
118+
### get_classes_in_collection(name, ECollectionShareType, recursion(optional))
119+
120+
returns a list with all the Classes. There is a third optional parameter for recursion. Default value is 1. This function works only with static collections
121+
122+
### get_parent_collection(name, ECollectionShareType)
123+
124+
returns the parent collection. If the collection has no parent, it returns None.
125+
126+
### has_collections()
127+
128+
returns True or False if the project has or doesn't have any collections.

0 commit comments

Comments
 (0)