| Copyright | (c) Jon Schoning 2015 |
|---|---|
| Maintainer | jonschoning@gmail.com |
| Stability | experimental |
| Portability | POSIX |
| Safe Haskell | None |
| Language | Haskell2010 |
Pinboard.Api
Description
Provides Pinboard Api Access (deserializes into Haskell data structures)
- getPostsRecent :: MonadPinboard m => Maybe [Tag] -> Maybe Count -> m Posts
- getPostsForDate :: MonadPinboard m => Maybe [Tag] -> Maybe Date -> Maybe Url -> m Posts
- getPostsAll :: MonadPinboard m => Maybe [Tag] -> Maybe StartOffset -> Maybe NumResults -> Maybe FromDateTime -> Maybe ToDateTime -> Maybe Meta -> m [Post]
- getPostsDates :: MonadPinboard m => Maybe [Tag] -> m PostDates
- getPostsMRUTime :: MonadPinboard m => m UTCTime
- getSuggestedTags :: MonadPinboard m => Url -> m [Suggested]
- addPost :: MonadPinboard m => Url -> Description -> Maybe Extended -> Maybe [Tag] -> Maybe DateTime -> Maybe Replace -> Maybe Shared -> Maybe ToRead -> m ()
- addPostRec :: MonadPinboard m => Post -> Replace -> m ()
- deletePost :: MonadPinboard m => Url -> m ()
- getTags :: MonadPinboard m => m TagMap
- renameTag :: MonadPinboard m => Old -> New -> m ()
- deleteTag :: MonadPinboard m => Tag -> m ()
- getUserSecretRssKey :: MonadPinboard m => m Text
- getUserApiToken :: MonadPinboard m => m Text
- getNoteList :: MonadPinboard m => m NoteList
- getNote :: MonadPinboard m => NoteId -> m Note
Posts
Arguments
| :: MonadPinboard m | |
| => Maybe [Tag] | filter by up to three tags |
| -> Maybe Count | number of results to return. Default is 15, max is 100 |
| -> m Posts |
posts/recent : Returns a list of the user's most recent posts, filtered by tag.
Arguments
| :: MonadPinboard m | |
| => Maybe [Tag] | filter by up to three tags |
| -> Maybe Date | return results bookmarked on this day |
| -> Maybe Url | return bookmark for this URL |
| -> m Posts |
posts/get : Returns one or more posts on a single day matching the arguments. If no date or url is given, date of most recent bookmark will be used.
Arguments
| :: MonadPinboard m | |
| => Maybe [Tag] | filter by up to three tags |
| -> Maybe StartOffset | offset value (default is 0) |
| -> Maybe NumResults | number of results to return. Default is all |
| -> Maybe FromDateTime | return only bookmarks created after this time |
| -> Maybe ToDateTime | return only bookmarks created before this time |
| -> Maybe Meta | include a change detection signature for each bookmark |
| -> m [Post] |
posts/all : Returns all bookmarks in the user's account.
Arguments
| :: MonadPinboard m | |
| => Maybe [Tag] | filter by up to three tags |
| -> m PostDates |
posts/dates : Returns a list of dates with the number of posts at each date.
getPostsMRUTime :: MonadPinboard m => m UTCTime #
posts/update : Returns the most recent time a bookmark was added, updated or deleted.
getSuggestedTags :: MonadPinboard m => Url -> m [Suggested] #
posts/suggest : Returns a list of popular tags and recommended tags for a given URL. Popular tags are tags used site-wide for the url; Recommended tags are drawn from the user's own tags.
Arguments
| :: MonadPinboard m | |
| => Url | the URL of the item |
| -> Description | Title of the item. This field is unfortunately named |
| -> Maybe Extended | Description of the item. Called |
| -> Maybe [Tag] | List of up to 100 tags |
| -> Maybe DateTime | creation time for this bookmark. Defaults to current time. Datestamps more than 10 minutes ahead of server time will be reset to current server time |
| -> Maybe Replace | Replace any existing bookmark with this URL. Default is yes. If set to no, will fail if bookmark exists |
| -> Maybe Shared | Make bookmark public. Default is "yes" unless user has enabled the "save all bookmarks as private" user setting, in which case default is "no" |
| -> Maybe ToRead | Marks the bookmark as unread. Default is "no" |
| -> m () |
posts/add : Add or Update a bookmark
Arguments
| :: MonadPinboard m | |
| => Post | a Post record |
| -> Replace | Replace any existing bookmark with the Posts URL. If set to no, will fail if bookmark exists |
| -> m () |
posts/add : Add or Update a bookmark, from a Post record
deletePost :: MonadPinboard m => Url -> m () #
posts/delete : Delete an existing bookmark.
Tags
getTags :: MonadPinboard m => m TagMap #
tags/get : Returns a full list of the user's tags along with the number of times they were used.
Arguments
| :: MonadPinboard m | |
| => Old | note: match is not case sensitive |
| -> New | if empty, nothing will happen |
| -> m () |
tags/rename : Rename an tag, or fold it in to an existing tag
deleteTag :: MonadPinboard m => Tag -> m () #
tags/delete : Delete an existing tag.
User
getUserSecretRssKey :: MonadPinboard m => m Text #
user/secret : Returns the user's secret RSS key (for viewing private feeds)
getUserApiToken :: MonadPinboard m => m Text #
user/api_token : Returns the user's API token (for making API calls without a password)
Notes
getNoteList :: MonadPinboard m => m NoteList #
notes/list : Returns a list of the user's notes (note text detail is not included)
getNote :: MonadPinboard m => NoteId -> m Note #
notes/id : Returns an individual user note. The hash property is a 20 character long sha1 hash of the note text.