shiori

Documentation

Index

• Constants
• type BookmarkResponse
• type BookmarksResponse
• type LoginResponse
• type Shiori
  • func NewShiori(endpoint string) *Shiori
  • func (v *Shiori) AddBookmark(url, title string) (*BookmarkResponse, error)
  • func (v *Shiori) DeleteBookmark(bookmarkIds []int) error
  • func (v *Shiori) GetBookmarks() (*BookmarksResponse, error)
  • func (v *Shiori) Login(username string, password string) (*LoginResponse, error)
  • func (v *Shiori) Logout(sessionId string) error

Constants

const (
	ID          = "shiori"
	EndpointKey = "endpoint"
	UsernameKey = "username"
	PasswordKey = "password"
)

Types

type BookmarkResponse

type BookmarkResponse struct {
	Id         int    `json:"id"`
	Url        string `json:"url"`
	Title      string `json:"title"`
	Excerpt    string `json:"excerpt"`
	Author     string `json:"author"`
	Public     int    `json:"public"`
	Modified   string `json:"modified"`
	Html       string `json:"html"`
	ImageURL   string `json:"imageURL"`
	HasContent bool   `json:"hasContent"`
	HasArchive bool   `json:"hasArchive"`
	Tags       []struct {
		Name string `json:"name"`
	} `json:"tags"`
	CreateArchive bool `json:"createArchive"`
}

type BookmarksResponse

type BookmarksResponse struct {
	Bookmarks []struct {
		Id         int    `json:"id"`
		Url        string `json:"url"`
		Title      string `json:"title"`
		Excerpt    string `json:"excerpt"`
		Author     string `json:"author"`
		Public     int    `json:"public"`
		Modified   string `json:"modified"`
		ImageURL   string `json:"imageURL"`
		HasContent bool   `json:"hasContent"`
		HasArchive bool   `json:"hasArchive"`
		Tags       []struct {
			Id   int    `json:"id"`
			Name string `json:"name"`
		} `json:"tags"`
		CreateArchive bool `json:"createArchive"`
	} `json:"bookmarks"`
	MaxPage int `json:"maxPage"`
	Page    int `json:"page"`
}

type LoginResponse

type LoginResponse struct {
	Session string `json:"session"`
	Account struct {
		Id       int    `json:"id"`
		Username string `json:"username"`
		Owner    bool   `json:"owner"`
	} `json:"account"`
}

type Shiori

type Shiori struct {
	// contains filtered or unexported fields
}

func NewShiori

func NewShiori(endpoint string) *Shiori

func (*Shiori) AddBookmark

func (v *Shiori) AddBookmark(url, title string) (*BookmarkResponse, error)

func (*Shiori) DeleteBookmark

func (v *Shiori) DeleteBookmark(bookmarkIds []int) error

func (*Shiori) GetBookmarks

func (v *Shiori) GetBookmarks() (*BookmarksResponse, error)

func (*Shiori) Login

func (v *Shiori) Login(username string, password string) (*LoginResponse, error)

func (*Shiori) Logout

func (v *Shiori) Logout(sessionId string) error