| Copyright | (c) Jon Schoning, 2015 |
|---|---|
| Maintainer | jonschoning@gmail.com |
| Stability | experimental |
| Portability | POSIX |
| Safe Haskell | None |
| Language | Haskell2010 |
Pinboard.Api
Description
- getPostsRecent :: Maybe [Tag] -> Maybe Count -> Pinboard Posts
- getPostsForDate :: Maybe [Tag] -> Maybe Date -> Maybe Url -> Pinboard Posts
- getPostsAll :: Maybe [Tag] -> Maybe StartOffset -> Maybe NumResults -> Maybe FromDateTime -> Maybe ToDateTime -> Maybe Meta -> Pinboard [Post]
- getPostsDates :: Maybe [Tag] -> Pinboard PostDates
- getPostsMRUTime :: Pinboard UTCTime
- getSuggestedTags :: Url -> Pinboard [Suggested]
- addPost :: Url -> Description -> Maybe Extended -> Maybe [Tag] -> Maybe DateTime -> Maybe Replace -> Maybe Shared -> Maybe ToRead -> Pinboard ()
- deletePost :: Url -> Pinboard ()
- getTags :: Pinboard TagMap
- renameTag :: Old -> New -> Pinboard ()
- deleteTag :: Tag -> Pinboard ()
- getUserSecretRssKey :: Pinboard Text
- getUserApiToken :: Pinboard Text
- getNoteList :: Pinboard NoteList
- getNote :: NoteId -> Pinboard Note
Posts
Arguments
| :: Maybe [Tag] | filter by up to three tags |
| -> Maybe Count | number of results to return. Default is 15, max is 100 |
| -> Pinboard Posts |
posts/recent : Returns a list of the user's most recent posts, filtered by tag.
Arguments
| :: Maybe [Tag] | filter by up to three tags |
| -> Maybe Date | return results bookmarked on this day |
| -> Maybe Url | return bookmark for this URL |
| -> Pinboard 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
| :: 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 |
| -> Pinboard [Post] |
posts/all : Returns all bookmarks in the user's account.
posts/dates : Returns a list of dates with the number of posts at each date.
getPostsMRUTime :: Pinboard UTCTime Source
posts/update : Returns the most recent time a bookmark was added, updated or deleted.
getSuggestedTags :: Url -> Pinboard [Suggested] Source
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
| :: 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 throw an error 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" |
| -> Pinboard () |
posts/add : Add a bookmark
deletePost :: Url -> Pinboard () Source
posts/delete : Delete an existing bookmark.
Tags
getTags :: Pinboard TagMap Source
tags/get : Returns a full list of the user's tags along with the number of times they were used.
tags/rename : Rename an tag, or fold it in to an existing tag
User
getUserSecretRssKey :: Pinboard Text Source
user/secret : Returns the user's secret RSS key (for viewing private feeds)
getUserApiToken :: Pinboard Text Source
user/api_token : Returns the user's API token (for making API calls without a password)
Notes
getNoteList :: Pinboard NoteList Source
notes/list : Returns a list of the user's notes (note text detail is not included)