Search.setCustomElementCollection (Method)
Assigns the specified collection to the specified custom element type(s).
Returns:
Void
Arguments:
Name | Type | Required | Description |
---|---|---|---|
collectionName | CollectionName_Existing_EmptyString | Required | |
customElementList | GlobalCustomElementIDList | Required | Updates the full-text collection associated with the selected custom element type(s). |
Context:
License Requirements | FullTextIndex |
Permission Requirements | site:ManageElements |
Deny Context | None |
Require Context | AuthoringEnabled |
Author Lock | (not required) |
Transaction Logging | If transaction logging is enabled at the site level, calls to this method will be logged |
Customization | This method may be customized at the site level |
Error Codes:
None
Notes:
Throws an error if the current user does not have Admin permissions for one or more of the specified custom element types. The collection(s) (new and old) need(s) to be re-indexed before the changes fully take effect.