skcli

Documentation

Index

• type Client
  • func NewClient(url, id, secret string) *Client
  • func (cli *Client) Annotations(ctx context.Context, id int) ([]sako.Annotation, error)
  • func (cli *Client) Auth(ctx context.Context, usr, pwd string) error
  • func (cli *Client) Close() error
  • func (cli *Client) Config(ctx context.Context) (sako.Config, error)
  • func (cli *Client) Entries() EntriesAPI
  • func (cli *Client) Info(ctx context.Context) (sako.Info, error)
  • func (cli *Client) Search(ctx context.Context, opts ...sako.SearchOptions) iter.Seq2[sako.Entry, error]
  • func (cli *Client) TaggingRules() TaggingRulesAPI
  • func (cli *Client) Tags(ctx context.Context) ([]sako.Tag, error)
  • func (cli *Client) User() UserAPI
• type EntriesAPI
  • func (api EntriesAPI) Add(ctx context.Context, url, title, content string, tags []string, ...) (sako.Entry, error)
  • func (api EntriesAPI) All(ctx context.Context, opts ...sako.FilterOptions) iter.Seq2[sako.Entry, error]
  • func (api EntriesAPI) Del(ctx context.Context, id int) (sako.Entry, error)
  • func (api EntriesAPI) Export(ctx context.Context, id sako.EntryID, format string) ([]byte, error)
  • func (api EntriesAPI) Get(ctx context.Context, id sako.EntryID) (sako.Entry, error)
  • func (api EntriesAPI) Has(ctx context.Context, urls []string) (map[string]sako.EntryID, error)
  • func (api EntriesAPI) Tags(ctx context.Context, id sako.EntryID) ([]sako.Tag, error)
• type TaggingRulesAPI
  • func (api TaggingRulesAPI) Get(ctx context.Context) ([]sako.TaggingRule, error)
  • func (api TaggingRulesAPI) Put(ctx context.Context, rules []sako.TaggingRule) error
• type UserAPI
  • func (api UserAPI) Get(ctx context.Context) (sako.User, error)
  • func (api UserAPI) Put(ctx context.Context, usr, pwd, email, name string) (sako.User, error)

Types

type Client

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

Client represents a sako client.

func NewClient

func NewClient(url, id, secret string) *Client

func (*Client) Annotations

func (cli *Client) Annotations(ctx context.Context, id int) ([]sako.Annotation, error)

func (*Client) Auth

func (cli *Client) Auth(ctx context.Context, usr, pwd string) error

func (*Client) Close

func (cli *Client) Close() error

func (*Client) Config

func (cli *Client) Config(ctx context.Context) (sako.Config, error)

func (*Client) Entries

func (cli *Client) Entries() EntriesAPI

func (*Client) Info

func (cli *Client) Info(ctx context.Context) (sako.Info, error)

func (*Client) Search

func (cli *Client) Search(ctx context.Context, opts ...sako.SearchOptions) iter.Seq2[sako.Entry, error]

func (*Client) TaggingRules

func (cli *Client) TaggingRules() TaggingRulesAPI

func (*Client) Tags

func (cli *Client) Tags(ctx context.Context) ([]sako.Tag, error)

func (*Client) User

func (cli *Client) User() UserAPI

type EntriesAPI

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

func (EntriesAPI) Add

func (api EntriesAPI) Add(ctx context.Context, url, title, content string, tags []string, starred, archived bool) (sako.Entry, error)

func (EntriesAPI) All

func (api EntriesAPI) All(ctx context.Context, opts ...sako.FilterOptions) iter.Seq2[sako.Entry, error]

func (EntriesAPI) Del

func (api EntriesAPI) Del(ctx context.Context, id int) (sako.Entry, error)

func (EntriesAPI) Export

func (api EntriesAPI) Export(ctx context.Context, id sako.EntryID, format string) ([]byte, error)

func (EntriesAPI) Get

func (api EntriesAPI) Get(ctx context.Context, id sako.EntryID) (sako.Entry, error)

func (EntriesAPI) Has

func (api EntriesAPI) Has(ctx context.Context, urls []string) (map[string]sako.EntryID, error)

func (EntriesAPI) Tags

func (api EntriesAPI) Tags(ctx context.Context, id sako.EntryID) ([]sako.Tag, error)

type TaggingRulesAPI

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

func (TaggingRulesAPI) Get

func (api TaggingRulesAPI) Get(ctx context.Context) ([]sako.TaggingRule, error)

func (TaggingRulesAPI) Put

func (api TaggingRulesAPI) Put(ctx context.Context, rules []sako.TaggingRule) error

type UserAPI

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

func (UserAPI) Get

func (api UserAPI) Get(ctx context.Context) (sako.User, error)

func (UserAPI) Put

func (api UserAPI) Put(ctx context.Context, usr, pwd, email, name string) (sako.User, error)