Search.createCollection (Method)
Creates a new full-text search collection within a parent directory. The subsites and perhaps their child subsites, if specified, will be associated with this collection.
Returns:
Void
Arguments:
Name | Type | Required | Description |
---|---|---|---|
collectionName | CollectionName_NonExisting | Required | The name of the Full-Text collection. |
subsiteIDList | SubsiteIDList_EmptyString | Optional. Defaults to an empty string. | A comma-delimited list of Subsite IDs to include in this new collection. |
includeChildSubsites | Boolean | Optional. Defaults to 'false'. | Boolean flag indicating whether content in child subsites will be included in this collection. |
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 |
---|---|
40007 | A collection already exists for parent directory '$1'. |
40008 | A collection with name '$1' already exists. |
40014 | The specified collection ParentDirectory '$1' does not exist. |
Notes:
None