Search.getAvailableCollections (Method)

Returns query containing names of all existing collections which are or can be assigned to the current site.

Returns:

Search_GetCollectionsList_Result (query)

Each row of the returned query results has the following fields:

Field Name Type Description
Name PlainText_NonNull The search collection's name.

Arguments:

Name Type Required Description
excludeList CollectionName_ExistingList_EmptyString Optional. Defaults to an empty string. Empty string, or a list of collection names to exclude from the results.

Context:

License Requirements FullTextIndex
Permission Requirements (none)
Deny Context None
Require Context None
Author Lock (not required)
Transaction Logging Transaction logging is disabled for this method
Customization This method may be customized at the site level

Error Codes:

None

Notes:

None