feedSetFeedInfo

Home > Books > Discovered Documentation > Discovered Documentation > PiNKY Library > feedSetFeedInfo

Module

The feedSetFeedInfo accessor is exported by the urn:org:pinkypipes:mod:pinky module. Import this module to gain access to the accessor.

Syntax

URI

active:feedSetFeedInfo

Argument	Rules	Description
feed	Mandatory	A feed resource
operator	Mandatory	Feed info resource

Example Usage

DPML

<instr>
  <type>feedSetFeedInfo</type>
  <feed>var:afeed</feed>
  <operator>var:xmlfeedinfo</operator>
  <target>var:updatedfeed</target>
</instr>

NetKernel Foundation API

req=context.createSubRequest("active:feedSetFeedInfo");
req.addArgument("feed", [resource representation, aspect, or URI] );
req.addArgument("operator", [resource representation, aspect, or URI] );
result=context.issueSubRequest(req);

Purpose

The feedSetFeedInfo accessor sets the feed metadata. The operator argument must provide a declarative <info> xml fragment containing the metadata for the feed (format is described below). The response is the feed with updated metadata.

XML Info Format

An example of the format for the <info> xml fragment containing the metadata is as follows:

<info>
  <author>pjr</author>
  <author>Team PiNKY</author>
  <contributor>ABC</contributor>
  <contributor>DEF</contributor>
  <description>Test</description>
  <title>Test Feed</title>
  <date>now</date>
  <uri>urn:org:pinkypipes:pinky:test:feed:1</uri>
  <language>en-test</language>
  <copyright>(C) PinkyPipes</copyright>
  <link>http://pinkypipes.org</link>
  <link>http://1060.org/blogxter/</link>
  <image>
    <title>Test Feed Image</title>
    <link>http://pinkypipes.org/</link>
    <url>http://pinkypipes.org/pinky-icon-128.png</url>
    <description>Pinky Feed Logo</description>
  </image>
  <category>
    <name>Test</name>
    <taxonomyuri>urn:org:pinkypipes:test</taxonomyuri>
  </category>
  <category>
    <name>Pinky</name>
    <taxonomyuri>urn:org:pinkypipes</taxonomyuri>
  </category>
</info>

The info doc must contain at least one of the following first child elements...

tag	supports multiple	description
author	Y	Sets the feed author(s) [RSS feeds only support a single author]
contributor	Y	Sets the feed contributor(s) [Not supported by RSS]
description	N	Sets the plain/text feed description
title	N	Sets the feed title
date	N	Sets the feed published date. A value of NOW will set the date to the current system time.
uri	N	Sets the feed URI [Not supported by RSS]
language	N	Sets the feed langauge identifier, example: en-gb
copyright	N	Sets the feed copyright notice
link	Y	Sets the feed link [RSS feeds only support a single link]
image	N	Sets the feed image icon and description. Requires child tags: title, link, url (the source of the image), description
category	Y	Sets the feed category classification. Requires child tags: name (category id), taxonomyuri (URI of the RDF taxonomy)

Example 1: Set the feed title

This is how to set the feed title using SetFeedInfo in a DPML script:

<instr>
  <type>feedSetFeedInfo</type>
  <feed>var:afeed</feed>
  <operator>
    <info>
      <title>Don't Judge a Feed by Its Cover</title>
    </info>
  </operator>
  <target>var:updatedfeed</target>
</instr>

Example 2: Set multiple things and update the date.

This is how to set the feed author, description, and update the publish date to the current system time using SetFeedInfo in a DPML script:

<instr>
  <type>feedSetFeedInfo</type>
  <feed>var:afeed</feed>
  <operator>
    <info>
      <author>Your Financial Services Corporation</author>
      <description>Your real-time personal wealth feed</description>
      <date>now</date>
    </info>
  </operator>
  <target>var:updatedfeed</target>
</instr>

For more details see the PiNKY guide.