XMLPublications (Component)

The XMLPublications object lets you manage RSS feeds. For example, its methods lets you save a feed's format, definition, and fields. Other methods let you change and delete feeds and their fields as well as obtain information about a feed.

Methods marked below with [L] may be logged at the site level (if transaction logging is licensed and enabled by the administrator)

Methods marked below with [C] may be customized at the site level

Methods:

changeDefinitionState [L] [C] Changes the state of an XML publication's definition to active or inactive.
changeFormatState [L] [C] Changes the state of an XML publication format to active or inactive.
changeItemFieldBindingState [L] [C] Changes an XML publication's binding state to active or inactive.
deleteDefinition [L] [C] Deletes an XML publication's definition and all of its metadata fields, item fields, bindings, formats, and XML publications.
deleteFormat [L] [C] Deletes an XML publication's format and all associated XML publications.
deleteItemFieldBinding [L] [C] Deletes an item field binding.
getBindableElementFields [C] Returns zero or more structures, each containing information about a field within the Element that CommonSpot can bind. Structure members contain the field's description, name, and ID.
getDefinitionList [C] Returns zero or more structures, each containing information on an XML publication. Structure members contain information on an XML feed's ID, name, state, and a publication count.
getFormatList [C] Returns zero or more structures, each containing information about an XML publication format. Structure members include a description, feed count, name, and so on.
getItemFieldBindingList [C] Returns zero or more structures, each containing information about the elements bound to a publication definition; for example, 'BindingID', 'ElementType', 'PublicationDefinitionName'. 'State', and so on.
getItemFieldBindings [C] Returns zero or more structures, each containing information on what fields are bound to which item field bindings for a publication definition and an element type.
getItemFieldDetail [C] Returns zero or more structures, each containing information on an item field, as follows: 'Description', 'ID', 'Name', and 'RequiredItemField'.
getItemFields [C] Returns zero or more structures, each containing information about the item fields associated with a publication, as follows: 'BindingCount', 'FieldID', 'Name', and 'RequiredItemField'.
getList [C] 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.
getXSLTModuleList [C] Returns zero or more structures, each containing information about the file name and path for an XML publication's format XSLT modules.
saveDefinition [L] [C] Either saves an existing XML publication definition or creates a new one.
saveFormat [L] [C] Saves or updates an XML publication format.
saveItemField [L] [C] Saves or updates an item's field.
saveItemFieldsOrder [L] [C] Tells CommonSpot to display item fields into the order in which they are listed within the 'itemFieldIDList' argument.