Site.getInfo (Method)
Returns a structure containing information about the current site; for example, 'authoringPermitted', 'AuthoringURL', 'DatabaseType', and so on.
Returns:
Site_GetInfo_Struct (struct)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| AuthoringPermitted | Boolean | Boolean flag which when true indicates that authoring is currently permitted. |
| AuthoringURL | ValidURL_EmptyString | If static content is generated, this is the URL to the authoring server. If it is not enabled, this is an empty string. |
| DatabaseType | DatabaseType | The database's manufacturer, which can be 'MySQL', 'Oracle', or 'SQLServer'. |
| DatabaseVersion | PlainText | The version of the site's database. |
| Datasource | PlainText_NonNull_255 | The name of the site's data source. |
| Description | PlainText_NonNull_2000 | The site's description. |
| IsOnROPS | Boolean | Boolean flag which when true indicates that the site is on a Read-Only Production Server or not. |
| isSharedDatabaseMaster | Boolean | A boolean flag which when set to true indicates that this server is the authoring server in a shared database configuration for this site. |
| LastReplicationRun | Datetime | The date and time of the last replication. |
| LastReplicationStatus | ReplicationSyncStatus | The status of the last replication. |
| LastStaticUpdate | Timestamp_EmptyString | The date and time when CommonSpot updated static data. An empty string means CommonSpot has never updated it. |
| LicenseKey | PlainText | The file name of the customer's license key file. |
| MaxReplicationTargetAllowed | NonNegativeInteger | The maximum number of replication targets that this customer license allows. |
| Name | PlainText_NonNull_50 | The site's name. |
| PublicDynamicURL | ValidURL_EmptyString | If static is enabled, the site's public URL. |
| RootPath | PlainText_NonNull | The file system path to the root of the site. |
| RootURL | ValidURL | The site's URL. |
| SchemaVersion | Timestamp | The date and time when CommonSpot last updated the site's database schema. |
| SharedDBAuthoringServerOnly | Boolean | Boolean flag which when true indicates that this site is only available on the authoring server in a shared database configuration. |
| State | SiteState | An integer representing the state of the site as follows: 0 (Inactive) or 1 (Active). |
| StaticDirectory | PlainText | The directory configured for static content generation. |
| StaticStatus | StaticStatus | An integer representing the site's static content generation status: 0 (Static Disabled) or 1 (Static Enabled). |
| StaticURL | ValidURL_EmptyString | If static content generation is enabled, this is the URL to the static site. If it has not be enabled, this is an empty string. |
| SyncSiteCount | NonNegativeInteger | The number of replication targets of the curent site. |
| TestDynamicURL | ValidURL_EmptyString | If static content generation is enabled, this is the test URL to dynamic content. If it has not be enabled, this is an empty string. |
| TestStaticURL | ValidURL_EmptyString | If static content generation is enabled, the test URL to dynamic content. If it has not be enabled, this is an empty string. |
| Type | SiteType | An integer representing the site's type: 0 (Non root-level site), 1 (Root-level site), or 2 (Site 0). |
Context:
| License Requirements | None |
| Permission Requirements | ContributorOrServerCode |
| Deny Context | None |
| Require Context | None |
| Author Lock |
Error Codes:
None
Notes:
None