Subsite.getInfo (Method)
Returns a structure containing general information for a subsite; for example, the subsite's name, ID, next and previous sibling subsites, and so on.
Returns:
Subsite_GetInfo_Result (struct)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| CreatedBy | UserID | The ID of the user who created this subsite. |
| DisableSearchIndexing | Boolean | Boolean flag which when true indicates that search indexing is disabled for the subsite. |
| DisplayName | PlainText | The subsite's display name. This name appears in the subsite's breadcrumbs element. |
| Language | LanguageName | The language set for the site. |
| NextID | SubsiteID_0 | The ID of the next sibling subsite. If no next sibling exists, CommonSpot sets this value to 0. |
| NextSubsiteURL | ServerRelativeURL_EmptyString | The server-relative URL of the next sibling subsite. If no next sibling exists, CommonSpot set this to an empty string. |
| NoOfImagesInSubsite | NonNegativeInteger | The number of images that exist in this subsite. |
| NoOfPagesInSubsite | NonNegativeInteger | The number of pages that exist in this subsite. |
| ParentID | SubsiteID_0 | The ID of the subsite's parent. If this is the root subsite, this value is 0. |
| PrevID | SubsiteID_0 | The ID of the previous sibling subsite. If no previous sibling exists, CommonSpot sets this value to 0. |
| PrevSubsiteURL | ServerRelativeURL_EmptyString | The server-relative URL of the previous sibling subsite. If no previous sibling exist, CommonSpot sets the value to 0. |
| SearchCollection | PlainText | The name of the search collection associated with the current subsite. |
| SearchDir | PlainText | The directory of the current subsite's search collection. |
| SecurityPageID | PageID | The ID of the security record for this page. |
| SubsiteDesc | PlainText_2000 | The current subsite's description. |
| SubsiteDir | PlainText_NonNull | The current subsite's directory. |
| SubsiteID | SubsiteID | The current subsite's ID. |
| SubsiteName | PlainText_NonNull_255 | The current subsite's name. |
| SubsiteURL | SubsiteURL | The current subsite's server-relative URL. |
| WebMasterEmail | EmailAddress | The email address of the user to notify regarding the current subsite. |
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| subsiteIDOrURL | SubsiteIDorURL_EmptyString | Required | The ID of the target subsite, or the server relative path to the target subsite, or an empty string for the current subsite. |
Context:
| License Requirements | None |
| Permission Requirements | ContributorOrServerCode |
| 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 |
|---|---|
| 54007 | Subsite '$1' does not exist. |
| 54011 | You must specify either a valid subsiteID or SubsiteURL. |
Notes:
None