Post Operations
string GetPostId(url)
Returns the NewsGator PostId for a given URL.
Parameters
- url
- A URL indicating the permanent link of a post.
PostState[] SetState(locationName, deletedPosts, readPosts, unreadPosts)
Sets a user's read/unread/deleted state for a set of posts;
returns a list of PostState structures indicating state changes recorded by NewsGator Online since the user's last
sync operation. Synchronization is therefore a "last one in wins" system, where the last state reported
on an item to NewsGator Online is the state for that item. The result of this method is a list of post/state pairs that
have been reported to NewsGator Online since the last sync operation (excluding states reported in the parameters to this
method), so the user agent can be made aware of state changes that it is likely not yet aware of.
Parameters
- locationName
- The name of the NewsGator location that is making this call.
- deletedPosts
- A list of post IDs to mark as deleted by this user.
- readPosts
- A list of post IDs to mark as read by this user.
- unreadPosts
- A list of post IDs to mark as unread by this user.
void RatePost(url, rating)
Parameters
- url
- The URL to rate.
- rating
- A rating for the post, in the range 1-5, inclusive.
int GetLinkCount(postId)
Returns the number of URLs that link to a specific post.
Parameters
- postId
- The postId (as returned from a call to GetPostId) to get
a link count for.
string[] GetLinks(postId)
Returns a list of URLs that contain links to a specific post.
Parameters
- postId
- The postId (as returned from a call to GetPostId) to
get the links for.
void ClipPosts(clipList)
Clips the specified post Ids to the specified folders.
Parameters
- clipList
- An array of ClippedPost structures, each consisting of the
postId (as returned from a call to GetPostId, or as the <ng:postId> element in GetNewsForFeed results)
to be clipped, and the folderId of the folder to store the clipping in. This folder must reside in the "MYC"
tree.
void UnClipPosts(postIds)
Removes the specified post Id from the authenticated user's clippings.
Parameters
- postId
- The postId (as returned from a call to GetPostId, or as the <ng:postId> element in
GetNewsForFeed results) to be unclipped
rss GetItems(postIds)
Creates an ad-hoc RSS feed from a list of post IDs. The posts specified must be current in
the source feed (as opposed to the NewsGator Online archive).
Parameters
- postIds
- A list of postIds (as returned from a call to GetPostId, or as the <ng:postId> element in
GetNewsForFeed results) for the data to be retrieved. This list is limited to 10 items, these items must be current in the source feed (as opposed to posts that are in
the NewsGator archive).
PostState[] UpdatePostMetadata(locationName, syncToken, newStates)
Updates the metadata for arbitrary posts as given in the newStates parameter,
returning metadata for posts that have changed since last update.
Parameters
- locationName
- The name of the location making this update
- syncToken
- A sync token from the last call to GetSubscriptionList. This is used as a hint when constructing the results;
since the server knows when the last sync occurred, it can omit state changes that occurred before the last sync,
yielding a smaller response.
- newStates
- An array of FeedMetadata structures
- FeedID
- The ID of the feed this post came from.
- PostMetadata
-
- PostID
- The NewsGator ID for the post
- State
- Flag field to indicate read state 1 = read, 2 = deleted (e.g. 3 means read and deleted)
- FlagState
- An integer indicating the flag state of the item. Clients can map any non-zero integer
to a generic "flagged" state, or can map values to specific color or style flags.
SOAP Endpoint