XMLPublications.getList (Method)
Returns zero or more structures, each containing information about XML publications within the site. The returned information can be constrained using the 'definitionID' and 'formatID' arguments.
Returns:
XMLPublicationDetails_Result (query)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| ElementType | PlainText_NonNull | The type of element from which the feed was created. |
| FeedDescription | PlainText | The feed's description. |
| FeedFormat | PlainText_NonNull | The feed's format. |
| FeedFormatIcon | ModulePath | The full path (including filename) of the feed's XML format icon. |
| FeedName | PlainText_NonNull | The feed's name. |
| FeedURL | ValidURL | The feed's full URL. |
| IsSyndicationFeed | Boolean | Boolean flag which when set to true indicates if the feed is a syndication. |
| PageID | PageID | The ID of the page that renders the feed. |
| PageName | Filename | The name of the page that renders the feed. |
| PageTitle | PlainText_NonNull | The title of the page that renders the feed. |
| PageURL | ServerRelativeURL | The server-relative URL to the page that renders the feed. |
| PublicationDefinitionID | PublicationDefinitionID | The ID of the underlying XML publication definition. |
| PublicationDefinitionName | PlainText | The name of the underlying XML publication definition. |
| State | Any | The XML publication's state. |
| SubsiteID | SubsiteID | The ID of the subsite in which the page resides. |
| SubsiteURL | SubsiteURL | The server-relative URL of the page's subsite. |
| UUID | UUID_EmptyString | The UUID of the feed, or an empty string. |
| XMLPublicationFormatID | XMLPublicationFormatID | The XML format's ID. |
| XMLPublicationID | XMLPublicationInstanceID | The feed instance's ID. |
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| definitionID | XMLPublicationDefinitionID_0 | Optional. Defaults to '0'. | The ID of an XML publication definition ID. If this value is 0, CommonSpot returns information for all definitions. |
| formatID | XMLPublicationFormatID_0 | Optional. Defaults to '0'. | The ID of an XML publication forma ID. If this value is 0, CommonSpot returns information for all of a definition's formats. |
Context:
| License Requirements | XMLPublication |
| 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 |
|---|---|
| 65022 | You cannot specify both the definition and format IDs as zero. |
Notes:
None