hoarder

Documentation

Index

• Constants
• type ArchiveResponse
• type AttachTagsResponse
• type Bookmark
  • func (b Bookmark) GetSummary() string
  • func (b Bookmark) GetTitle() string
• type BookmarkContent
• type BookmarkTagRequest
• type BookmarkTagsInner
• type BookmarksBookmarkIdAssets
• type BookmarksResponse
• type Hoarder
  • func GetClient() *Hoarder
  • func NewHoarder(endpoint string, apiKey string) *Hoarder
  • func (i *Hoarder) ArchiveBookmark(id string) (bool, error)
  • func (i *Hoarder) AttachTagsToBookmark(bookmarkId string, tags []string) ([]string, error)
  • func (i *Hoarder) CreateBookmark(url string) (*Bookmark, error)
  • func (i *Hoarder) GetAllBookmarks(limit int) ([]Bookmark, error)
  • func (i *Hoarder) GetAllTags() ([]Tag, error)
• type Tag
• type TagNumBookmarksByAttachedType
• type TagsResponse

Constants

const (
	ID          = "hoarder"
	EndpointKey = "endpoint"
	ApikeyKey   = "api_key"
)

const (
	MaxPageSize = 100
)

Types

type ArchiveResponse

type ArchiveResponse struct {
	Archived bool `json:"archived"`
}

type AttachTagsResponse

type AttachTagsResponse struct {
	Attached []string `json:"attached"`
}

type Bookmark

type Bookmark struct {
	Id            string                      `json:"id"`
	CreatedAt     string                      `json:"createdAt"`
	ModifiedAt    *string                     `json:"modifiedAt"`
	Title         *string                     `json:"title,omitempty"`
	Archived      bool                        `json:"archived"`
	Favourited    bool                        `json:"favourited"`
	TaggingStatus *string                     `json:"taggingStatus"`
	Note          *string                     `json:"note,omitempty"`
	Summary       *string                     `json:"summary,omitempty"`
	Tags          []BookmarkTagsInner         `json:"tags"`
	Assets        []BookmarksBookmarkIdAssets `json:"assets"`
	Content       BookmarkContent             `json:"content"`
}

func (Bookmark) GetSummary

func (b Bookmark) GetSummary() string

func (Bookmark) GetTitle

func (b Bookmark) GetTitle() string

type BookmarkContent

type BookmarkContent struct {
	Type                     string  `json:"type"`
	Url                      string  `json:"url"`
	Title                    *string `json:"title,omitempty"`
	Description              *string `json:"description,omitempty"`
	ImageUrl                 *string `json:"imageUrl,omitempty"`
	ImageAssetId             *string `json:"imageAssetId,omitempty"`
	ScreenshotAssetId        *string `json:"screenshotAssetId,omitempty"`
	FullPageArchiveAssetId   *string `json:"fullPageArchiveAssetId,omitempty"`
	PrecrawledArchiveAssetId *string `json:"precrawledArchiveAssetId,omitempty"`
	VideoAssetId             *string `json:"videoAssetId,omitempty"`
	Favicon                  *string `json:"favicon,omitempty"`
	HtmlContent              *string `json:"htmlContent,omitempty"`
	CrawledAt                *string `json:"crawledAt,omitempty"`
}

type BookmarkTagRequest

type BookmarkTagRequest struct {
	TagName string `json:"tag_name"`
}

type BookmarkTagsInner

type BookmarkTagsInner struct {
	Id         string `json:"id"`
	Name       string `json:"name"`
	AttachedBy string `json:"attachedBy"`
}

type BookmarksBookmarkIdAssets

type BookmarksBookmarkIdAssets struct {
	Id        string `json:"id"`
	AssetType string `json:"assetType"`
}

type BookmarksResponse

type BookmarksResponse struct {
	Bookmarks []Bookmark `json:"bookmarks"`
}

type Hoarder

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

func GetClient

func GetClient() *Hoarder

func NewHoarder

func NewHoarder(endpoint string, apiKey string) *Hoarder

func (*Hoarder) ArchiveBookmark

func (i *Hoarder) ArchiveBookmark(id string) (bool, error)

func (*Hoarder) AttachTagsToBookmark

func (i *Hoarder) AttachTagsToBookmark(bookmarkId string, tags []string) ([]string, error)

func (*Hoarder) CreateBookmark

func (i *Hoarder) CreateBookmark(url string) (*Bookmark, error)

func (*Hoarder) GetAllBookmarks

func (i *Hoarder) GetAllBookmarks(limit int) ([]Bookmark, error)

func (*Hoarder) GetAllTags

func (i *Hoarder) GetAllTags() ([]Tag, error)

type Tag

type Tag struct {
	Id                         string                        `json:"id"`
	Name                       string                        `json:"name"`
	NumBookmarks               float32                       `json:"numBookmarks"`
	NumBookmarksByAttachedType TagNumBookmarksByAttachedType `json:"numBookmarksByAttachedType"`
}

type TagNumBookmarksByAttachedType

type TagNumBookmarksByAttachedType struct {
	Ai    *float32 `json:"ai,omitempty"`
	Human *float32 `json:"human,omitempty"`
}

type TagsResponse

type TagsResponse struct {
	Tags []Tag `json:"tags"`
}