Search.setSubsiteCollection (Method)
Sets the full text search collection for the specified subsites.
Returns:
Void
Arguments:
Name | Type | Required | Description |
---|---|---|---|
subsiteIDList | SubsiteIDList | Required | A comma-delimited list on one or more subsite IDs for which the current user has administrative permissions. |
collectionName | CollectionName_Existing_EmptyString | Required | A collection's name or an empty string. If this is an empty string, CommonSpot removes the subsites listed in the 'subsiteIDList' argument from all collections. |
Context:
License Requirements | FullTextIndex |
Permission Requirements | anySubsite:SubsiteAdmin |
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:
Code | Error Message |
---|---|
40015 | You do not have admin permissions for one or more of the specified subsites. |
Notes:
Throws an error if the current user does not have Site Admin permissions for one or more of the specified subsites. The collection(s) (new and old) needs to be re-indexed before the changes apply.