armariaapi

Documentation

Index

• func AddBook(url string, options addBookOptions) (armaria.Book, error)
• func AddFolder(name string, options addFolderOptions) (armaria.Book, error)
• func AddTags(id string, tags []string, options addTagsOptions) (armaria.Book, error)
• func DefaultAddBookOptions() addBookOptions
• func DefaultAddFolderOptions() addFolderOptions
• func DefaultAddTagsOptions() addTagsOptions
• func DefaultListBooksOptions() listBookOptions
• func DefaultListTagsOptions() listTagsOptions
• func DefaultRemoveBookOptions() removeBookOptions
• func DefaultRemoveFolderOptions() removeFolderOptions
• func DefaultRemoveTagsOptions() removeTagsOptions
• func DefaultUpdateBookOptions() updateBookOptions
• func DefaultUpdateFolderOptions() updateFolderOptions
• func GetConfig() (armaria.Config, error)
• func InstallManifestChrome() error
• func InstallManifestChromium() error
• func InstallManifestFirefox() error
• func ListBooks(options listBookOptions) ([]armaria.Book, error)
• func ListTags(options listTagsOptions) ([]string, error)
• func RemoveBook(id string, options removeBookOptions) (err error)
• func RemoveFolder(id string, options removeFolderOptions) error
• func RemoveTags(id string, tags []string, options removeTagsOptions) (armaria.Book, error)
• func UpdateBook(id string, options updateBookOptions) (armaria.Book, error)
• func UpdateConfig(update UpdateConfigCallback) error
• func UpdateFolder(id string, options updateFolderOptions) (armaria.Book, error)
• type UpdateConfigCallback

Functions

func AddBook

func AddBook(url string, options addBookOptions) (armaria.Book, error)

AddBook adds a bookmark to the bookmarks database.

func AddFolder

func AddFolder(name string, options addFolderOptions) (armaria.Book, error)

AddFolder adds a folder to the bookmarks database.

func AddTags

func AddTags(id string, tags []string, options addTagsOptions) (armaria.Book, error)

AddTags adds tags to a bookmark in the bookmarks database.

func DefaultAddBookOptions

func DefaultAddBookOptions() addBookOptions

DefaultAddBookOptions are the default options for AddBook.

func DefaultAddFolderOptions

func DefaultAddFolderOptions() addFolderOptions

DefaultAddFolderOptions are the default options for AddFolder.

func DefaultAddTagsOptions

func DefaultAddTagsOptions() addTagsOptions

DefaultAddTagsOptions are the default options for AddTags.

func DefaultListBooksOptions

func DefaultListBooksOptions() listBookOptions

DefaultListBooksOptions are the default options for ListBooks.

func DefaultListTagsOptions

func DefaultListTagsOptions() listTagsOptions

DefaultListTagsOptions are the default options for ListTags.

func DefaultRemoveBookOptions

func DefaultRemoveBookOptions() removeBookOptions

DefaultRemoveBookOptions are the default options for RemoveBook.

func DefaultRemoveFolderOptions

func DefaultRemoveFolderOptions() removeFolderOptions

DefaultRemoveFolderOptions are the default options for RemoveFolder.

func DefaultRemoveTagsOptions

func DefaultRemoveTagsOptions() removeTagsOptions

DefaultRemoveTagsOptions are the default options for RemoveTags.

func DefaultUpdateBookOptions

func DefaultUpdateBookOptions() updateBookOptions

DefaultUpdateBookOptions are the default options for UpdateBook.

func DefaultUpdateFolderOptions

func DefaultUpdateFolderOptions() updateFolderOptions

DefaultUpdateFolderOptions are the default options for UpdateFolder.

func GetConfig

func GetConfig() (armaria.Config, error)

GetConfig gets the current config. If the sentinel error ErrConfigMissing then it doesn't exist.

func InstallManifestChrome

func InstallManifestChrome() error

InstallManifestChrome installs the app manifest for Firefox.

func InstallManifestChromium

func InstallManifestChromium() error

InstallManifestChromium installs the app manifest for Firefox.

func InstallManifestFirefox

func InstallManifestFirefox() error

InstallManifestFirefox installs the app manifest for Firefox.

func ListBooks

func ListBooks(options listBookOptions) ([]armaria.Book, error)

ListBooks lists bookmarks and folders in the bookmarks database.

func ListTags

func ListTags(options listTagsOptions) ([]string, error)

ListTags lists tags in the bookmarks database.

func RemoveBook

func RemoveBook(id string, options removeBookOptions) (err error)

RemoveBook removes a bookmark from the bookmarks database.

func RemoveFolder

func RemoveFolder(id string, options removeFolderOptions) error

RemoveFolder removes a folder from the bookmarks database.

func RemoveTags

func RemoveTags(id string, tags []string, options removeTagsOptions) (armaria.Book, error)

RemoveTags removes tags from a bookmark in the bookmarks database.

func UpdateBook

func UpdateBook(id string, options updateBookOptions) (armaria.Book, error)

UpdateBook updates a bookmark in the bookmarks database.

func UpdateConfig

func UpdateConfig(update UpdateConfigCallback) error

UpdateConfig updates the current config. It will be created if it hasn't already been created.

func UpdateFolder

func UpdateFolder(id string, options updateFolderOptions) (armaria.Book, error)

UpdateFolder updates a folder in the bookmarks database.

Types

type UpdateConfigCallback

type UpdateConfigCallback func(config *armaria.Config)

UpdateConfigCallback is a callback to update the current config