Search.setObjectCollection (Method)

Assigns the specified collection to the given subsites and/or custom element types.

Returns:

Void

Arguments:

Name Type Required Description
collectionName CollectionName_Existing_EmptyString Required  
subsiteIDList SubsiteIDList_EmptyString Required  
customElementList GlobalCustomElementIDList_EmptyString Required  

Context:

License Requirements FullTextIndex
Permission Requirements Contributor
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 Or Site Admin permissions for one or more of the specified subsites. The collection(s) (new and old) need(s) to be re-indexed before the changes fully take effect.