Channel operations

$/channels/list
Returns information about one or more channels.
Channels can be specified either by ID (recommended), by name, via channel filters, or channel folders.
Parameters:
idComma-separated list of channel ID's.
Use * to return all channels.
name (n)Comma-separated list of channel names.
Use * to return all channels. Enable the regex switch to use regular expressions.
filterComma-separated list of channel filter names.
Enable the regex switch to use regular expressions.
regex (re)Flags if channel names and channel filter names should be interpreted as regular expressions.
Special characters such as , and & can be hex-encoded e.g. \x2C or \x26 respectively).
folderIdComma-separated list of channel folder ID's.
folderNameComma-separated list of channel folder names.
subFoldersFlags if channels in sub-folders of a targeted folder should be returned.
Only applies to the folderId and folderName parameters.
verbose (v) Flags if verbose information should be returned about each channel.
The standard parameters recognized by all Awasu API calls are listed here.
$/channels/get
Returns the summary page for a channel.
Any combination of ID (recommended), name and/or filter may be specified, but only one channel must match.
Parameters:
idChannel ID.
name (n)Channel name.
Enable the regex switch to use regular expressions.
filterComma-separated list of channel filter names.
Enable the regex switch to use regular expressions.
regex (re)Flags if channel names and channel filter names should be interpreted as regular expressions.
Special characters such as , and & can be hex-encoded e.g. \x2C or \x26 respectively).
showFeedItemsMode (sfim) Controls which feed items will be shown (default|all|unread|new).
showFeedItemsWindow (sfiw) Controls how many feed items will be shown (positive values are the number of days to go back, negative values are the number of feed items, 0 means "default").
feedItemDescriptionFormat (fidf) Controls the presentation of feed item content (default|full|excerpt|plainText).
The standard parameters recognized by all Awasu API calls are listed here.
$/channels/open
Opens one or more channels in Awasu.
Channels can be specified either by ID (recommended), by name, via channel filters or channel folders.
Parameters:
idComma-separated list of channel ID's.
Use * to open all channels.
name (n)Comma-separated list of channel names.
Use * to open all channels. Enable the regex switch to use regular expressions.
filterComma-separated list of channel filter names.
Enable the regex switch to use regular expressions.
regex (re)Flags if channel names and channel filter names should be interpreted as regular expressions.
Special characters such as , and & can be hex-encoded e.g. \x2C or \x26 respectively).
folderIdComma-separated list of channel folder ID's.
folderNameComma-separated list of channel folder names.
subFoldersFlags if channels in sub-folders of a targeted folder should be returned.
Only applies to the folderId and folderName parameters.
The standard parameters recognized by all Awasu API calls are listed here.
$/channels/create
Creates a new channel.
The channel configuration must be passed in as the POST data. See below for more details.
Parameters: None
The standard parameters recognized by all Awasu API calls are listed here.
$/channels/update
Updates one or more channels.
Changes to the channel configuration must be passed in as the POST data. See below for more details.
Channels can be specified either by ID (recommended), by name, via channel filters, or channel folders.
Parameters:
idComma-separated list of channel ID's.
Use * to update all channels.
name (n)Comma-separated list of channel names.
Use * to update all channels. Enable the regex switch to use regular expressions.
filterComma-separated list of channel filter names.
Enable the regex switch to use regular expressions.
regex (re)Flags if channel names and channel filter names should be interpreted as regular expressions.
Special characters such as , and & can be hex-encoded e.g. \x2C or \x26 respectively).
folderIdComma-separated list of channel folder ID's.
folderNameComma-separated list of channel folder names.
subFoldersFlags if channels in sub-folders of a targeted folder should be returned.
Only applies to the folderId and folderName parameters.
The standard parameters recognized by all Awasu API calls are listed here.
$/channels/delete
Deletes one or more channels.
Channels can be specified either by ID (recommended), by name, via channel filters, or channel folders.
Parameters:
idComma-separated list of channel ID's.
Use * to delete all channels.
name (n)Comma-separated list of channel names.
Use * to delete all channels. Enable the regex switch to use regular expressions.
filterComma-separated list of channel filter names.
Enable the regex switch to use regular expressions.
regex (re)Flags if channel names and channel filter names should be interpreted as regular expressions.
Special characters such as , and & can be hex-encoded e.g. \x2C or \x26 respectively).
folderIdComma-separated list of channel folder ID's.
folderNameComma-separated list of channel folder names.
subFoldersFlags if channels in sub-folders of a targeted folder should be returned.
Only applies to the folderId and folderName parameters.
The standard parameters recognized by all Awasu API calls are listed here.
$/channels/errors
Gets the error log for one or more channels.
Channels can be specified either by ID (recommended), by name, via channel filters, or channel folders.
Parameters:
idComma-separated list of channel ID's.
Use * to get the error log for all channels.
name (n)Comma-separated list of channel names.
Use * to get the error log all channels. Enable the regex switch to use regular expressions.
filterComma-separated list of channel filter names.
Enable the regex switch to use regular expressions.
regex (re)Flags if channel names and channel filter names should be interpreted as regular expressions.
Special characters such as , and & can be hex-encoded e.g. \x2C or \x26 respectively).
folderIdComma-separated list of channel folder ID's.
folderNameComma-separated list of channel folder names.
subFoldersFlags if channels in sub-folders of a targeted folder should be returned.
Only applies to the folderId and folderName parameters.
The standard parameters recognized by all Awasu API calls are listed here.
$/channels/subscribe
Starts the Channel Wizard.
Parameters:
url (u) The feed URL to preload.
The standard parameters recognized by all Awasu API calls are listed here.
$/channels/import
Starts the Import from dialog.
Parameters:
url (u) The URL of the import file.
type (t) The format being used to import channels.
Currently only OPML is supported.
The standard parameters recognized by all Awasu API calls are listed here.
$/channels/folders/tree
Returns information about the My Channels folders.
Parameters: None
The standard parameters recognized by all Awasu API calls are listed here.
$/channels/folders/create
Creates a new My Channels folder.
Parameters:
name (n) The name of the new folder.
parent (p) The ID of the parent folder.
after (a) The ID of the folder to insert the new folder after.
The standard parameters recognized by all Awasu API calls are listed here.
$/channels/folders/delete
Deletes a My Channels folder.
Parameters:
id The ID of the folder to be deleted.
Use * to delete all folders.
The standard parameters recognized by all Awasu API calls are listed here.
$/channels/filters/list
Returns information about the channel filters.
Parameters:
verbose (v) Flags if verbose information should be returned about each channel filter.
The standard parameters recognized by all Awasu API calls are listed here.

Creating and updating channels

When creating a new channel, or updating existing ones, the channel configuration must be sent as the request's POST data. The format is the same as that returned by $/channels/list except that there is no top-level <channels> node. For example, the following POST request sent to $/channels/create will create a new channel:

<channel type="standard">
    <feedUrl> http://awasu.com/news.xml </feedUrl>
</channel>

Channel type

The type of channel is configured via the channel@type attribute:

Channel configuration

Most channel configuration is fairly straight-forward and values are configured via child nodes in the root <channel> node.

Basic channel details such as its name and description are usually specified by the publisher in the feed itself but can be overridden by the user e.g.

<channel type="standard">
    <name> ... </name>
    <description> ... </description>
    <homeUrl> ... </homeUrl>
</channel>

The channel summary page can be configured like this:

<channel type="...">
    <channelSummary compact="no" showItems="..." itemWindow="..." contentFormat="..."> 
        <templateFilename> {:INSTALL-DIR:}/Resources/Channel Summary Templates/Rusty.template </templateFilename>
    </channelSummary>
 </channel>
where:

Feed authentication

The username and/or password can be set for channels as follows:

<channel type="standard">
    <auth>
        <name> ... </name>
        <password> ... </password>
    </auth>
</channel>

To remove the authentication details from a channel, include an empty <auth> node:

<channel type="standard">
    <auth />
</channel>

Channel hooks

Channel hooks can be added to new or existing channels as follows:

<channel type="...">
    <channelHook path="...">
        <param name="..."> ... </param>   include as needed
    </channelHook>
</channel>

To update a hook that has already been attached to a channel, it must be identified by its ID. The hook itself cannot be changed and so only the display name and/or hook parameters may be altered.

To detach a hook from a channel, include a delete="yes" attribute e.g.

<channel type="...">
    <channelHook id="..." delete="yes" />
</channel>

Directory aliases

Any settings that include a directory path (e.g. template filename or output filename) can use one of the following directory aliases:

{:INSTALL-DIR:} the Awasu installation directory
{:USER-DATA:} the user's roaming data directory
{:USER-LOCALDATA:} the user's local data directory
{:USER-OUTPUT:} the user's My Documents folder