Page.getCacheProperties (Method)
Returns a structure whose members contain information about a page's cache properties.
Returns:
Page_GetCacheProperties_Result (struct)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| CacheBlockReasons | PlainText | A comma-delimited list of one or more human readable strings describing the reasons why the page cannot be cached. |
| dynamicContentCacheControl | CacheControl | A string describing how the 'Cache Dynamic Content' property is controlled (i.e. Custom, Site, Template, Never). |
| dynamicContentCacheKeepTime | Integer | The amount of time to keep cache for dynamic content. See 'dynamicContentCacheKeepTimeUnit' to specify the unit of time. |
| dynamicContentCacheKeepTimeUnit | TimeUnit_DHMS | A string identifying a unit of time as being days, hours, minutes or seconds. |
| DynamicStatus | String | A comma-delimited list of one or more dynamic status strings describing the reasons why the page is dynamic. |
| FileName | Filename | The page's filename. |
| HasDynamicContent | CacheDynamicContentStatus | An integer representing the dynamic state of the content; for example, 0 ('ManualStatic'), 3 ('AutoDetectDynamic'), 5 ('MandatoryDynamic'), and so on. |
| staleCacheCacheControl | CacheControl | A string describing how the 'Stale Cache Handling' property is controlled (i.e. Custom, Site, Template, Never). |
| staleCacheMaxKeepTime | NonNegativeInteger | The maximum time in minutes to keep stale cache. If -1 the cache will always be used. If 0 the cache will never be used. |
| staleCacheMaxKeepTimeUnit | TimeUnit_DHMS | A string identifying a unit of time as being days, hours, minutes or seconds. |
| StaticIsEnabled | Boolean | Boolean flag which when set to true indicates if creating static pages is enabled. |
| StaticRenderMode | StaticRenderMode | String identifying cache detection modes; for example, 0 (manual static), 1 (manual dynamic), or 2 (auto detect). |
| SubsiteID | SubsiteID | The subsite's ID. |
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| pageID | RealPageID_AnyTemplate | Required | A page's ID. |
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:
None
Notes:
None