Folder Operations

User agents may optionally support the NewsGator Online folder structure. This allows the user to have a more seamless reading experience between the various NewsGator editions and NewsGator Online user agents. Folders are configured globally for a user; NewsGator Online users can configure folder structures under the "My Clippings" and "My Feeds" hierarchy. Folders are assigned IDs within NewsGator Online and are generally addressed with these IDs; an ID of 0 means the root of a hierarchy. Subscriptions may be placed in any folder under the My Feeds hierarchy; the My Clippings hierarchy is used to hold posts that the user has clipped (Clippings functionality is not available at this time but will be in a future release).

XmlElement GetFolders()

Returns the user's folder hierarchy defined in NewsGator Online. The result of this call is an OPML document with NewsGator extensions.

int CreateFolder(name, parentId, root)

This operation creates a folder in NewsGator Online, returning the identifier for the newly created folder. The (name, parentId, root) tuple must be unique within the folder hierarchy, if it is not, this method will throw a client fault.

Parameters

name

The name for the folder.

parentId

The id for the parent of the folder, 0 means the root of the hierarchy.

root

Identifies the root of the hierarchy that the folder is to be created in. The root parameter must be either "MYC" or "MYF" for the My Clippings and My Feeds hierarchies, respectively.

int GetOrCreateFolder(name, parentId, root)

Operates like CreateFolder, but if the specified folder exists, it will return the id of that folder.

Parameters

name

The name for the folder.

parentId

The id for the parent of the folder, 0 means the root of the hierarchy.

root

Identifies the root of the hierarchy that the folder is to be created in. The root parameter must be either "MYC" or "MYF" for the My Clippings and My Feeds hierarchies, respectively.

void DeleteFolder(id)

Deletes the folder indicated by id. Any subscriptions in the folder will be moved to the parent folder.

Parameters

id

Identifier for the folder, as returned by the CreateFolder call.

void MoveFolder(id, newParentId)

Moves the folder indicated by id under the folder indicated by newParentId.

Parameters

id

Identifier for the folder that is to be moved.

newParentId

Identifier for the folder to set as the parent for the folder being moved.

void RenameFolder(id, newName)

Changes the name of the folder indicated by id to the value given in the newName parameter.

Parameters

id

The identifier of the folder to rename.

newName

The new name for the folder.

SOAP Endpoint