Replication.getDirectories (Method)
Returns zero or more structures, each containing information on the directories that CommonSpot scans when it replicates information.
Returns:
Replication_GetDirectories_Result (query)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| CachingOptions | ReplicationCacheOption | String representing the action to perform against the target server's cache when CommonSpot is replicating the source server. Examples are 'Clear Entire Cache', 'Clear Subsite Cache', and so on. |
| Directory | DirectoryPath | A directory's name. |
| ID | ReplicationDirectoryID | The ID of the directory to which CommonSpot replicates information. |
| IncludeSubdirectories | Boolean | Boolean flag which when set to true indicates that descendant directories are scanned in addition to the specified directory. |
| OneTimeScan | Boolean | Boolean flag which when set to true indicates that the directory is scanned the next time replication occurs. After this scan, CommonSpot no longer scans the directory. |
| ScanAction | ReplicationScanType | String describing when CommonSpot will scan the directory for replication. Possible values are 'Always Scan', 'Scan only on Full Replication', or 'On Content Change'. |
| Type | ReplicationDirType | String indicating the type of the directory being replicated; that is, 'SiteRelative', 'SubsiteRelative', or 'External', If this is empty string, CommonSpot will scan all directory types. |
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| type | ReplicationDirType_Empty | Optional. Defaults to an empty string. | An empty string (meaning all directory types) or a replication directory type: 'ExternalDirectory', 'SiteRelative', and 'Subsite Relative'. |
| directory | PlainText | Optional. Defaults to an empty string. | The directory for which CommonSpot returns results. Entering an empty string instead of a directory name tells CommonSpot to return information for all directories. |
Context:
| License Requirements | Replication |
| Permission Requirements | site:ManageReplication |
| 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:
| Code | Error Message |
|---|---|
| 36007 | You must specify a type if you specify a directory. |
Notes:
None