api

package

Go to main page

Versions in this module

v0

v0.1.1

Sep 10, 2025

v0.1.0

Sep 10, 2025

Changes in this version

+ func ApplicationCmd() *cobra.Command

+ func IsEagleNotOpenOrUnavailableError(err error) bool

+ func ItemCmd() *cobra.Command

+ func LibraryCmd() *cobra.Command

type ItemAddBookmarkOptions

+ func (o ItemAddBookmarkOptions) Validate() error

+ func (o ItemAddBookmarkOptions) WithDefaults() ItemAddBookmarkOptions

type ItemAddFromPathOptions

+ func (o ItemAddFromPathOptions) Validate() error

type ItemAddFromUrlOptions

+ func (o ItemAddFromUrlOptions) Validate() error

+ func (o ItemAddFromUrlOptions) WithDefaults() ItemAddFromUrlOptions

type ItemListOptions

+ func (o ItemListOptions) WithDefaults() ItemListOptions

type ItemUpdateOptions

+ func (o ItemUpdateOptions) Validate() error

v0.0.12

Sep 8, 2025

Changes in this version

+ func ApplicationCmds() []*cobra.Command

+ func FolderCmd() *cobra.Command

v0.0.11

Sep 7, 2025

v0.0.10

Jul 9, 2025

v0.0.9

Jun 30, 2025

v0.0.8

Jun 29, 2025

v0.0.7

Jun 28, 2025

Changes in this version

+ var EagleNotOpenOrUnavailableErr = fmt.Errorf("Eagle is not open or unavailable.")

+ var LibraryIsAlreadyTargetErr = errors.New("Library is already active")

+ func GetCurrentLibraryIsAlreadyTargetError(currLib string) error

+ func IsEagleNotOpenOrUnavailable(err error) bool

v0.0.6

Jun 20, 2025

v0.0.5

Jun 20, 2025

v0.0.4

Jun 20, 2025

Changes in this version

+ func StructToURLValues(data interface{}) (url.Values, error)

type ListItem

+ Folders []string

v0.0.3

Jun 10, 2025

Changes in this version

+ const MaxEagleItemIDLength

+ var EagleNotOpenErr = fmt.Errorf("Eagle is not open.")

+ var ErrStatusErr = fmt.Errorf("response key 'status' was not 'success'")

+ func FolderRename(baseUrl string, folderId string, newName string) error

+ func FolderUpdate(baseUrl string, folderId string, newName string, newDescription string, ...) error

+ func InvokeEagleAPIV2[T any](req *http.Request, v *T) error

+ func IsEagleNotOpenErr(err error) bool

+ func IsValidItemID(id string) bool

+ func ItemAddBookmark(baseUrl string, item ItemAddBookmarkOptions) error

+ func ItemAddFromPath(baseUrl string, item ItemAddFromPathOptions) error

+ func ItemAddFromPaths(baseUrl string, items []ItemAddFromPathOptions) error

+ func ItemAddFromUrl(baseUrl string, item ItemAddFromUrlOptions) error

+ func ItemAddFromUrls(baseUrl string, items []ItemAddFromUrlOptions, folderId string) error

+ func ItemMoveToTrash(baseUrl string, ids []string) error

+ func ItemRefreshPalette(baseUrl string, id string) error

+ func ItemRefreshThumbnail(baseUrl string, id string) error

+ func ItemThumbnail(baseUrl string, itemId string) (string, error)

+ func LibraryHistory(baseURL string) ([]string, error)

+ func LibraryIcon(baseURL string) (string, error)

+ func LibrarySwitch(baseURL string, libraryPath string) error

+ func RegisterGroupRoutes(g *echo.Group)

+ func RegisterRootRoutes(server *echo.Echo)

+ func Request[T any](method string, url string, body io.Reader, urlParam *url.Values, v *T) error

+ type ApiItem struct

+ Annotation string

+ Ext string

+ Folders []string

+ Height int

+ ID string

+ IsDeleted bool

+ LastModified int64

+ ModificationTime int64

+ Name string

+ NoThumbnail *bool

+ Palettes []Palette

+ Size int

+ Star *int

+ Tags []string

+ URL string

+ Width int

+ func ItemInfo(baseUrl string, id string) (respItem ApiItem, err error)

+ func ItemUpdate(baseUrl string, item ItemUpdateOptions) (respItem ApiItem, err error)

+ type ApiKeyErr struct

+ Message string

+ func (e *ApiKeyErr) Error() string

+ type ApplicationInfoData struct

+ BuildVersion string

+ ExecPath string

+ Platform string

+ PreReleaseVersion string

+ Version string

+ func ApplicationInfo(baseUrl string) (ApplicationInfoData, error)

+ type BaseItem struct

+ type BulkItem struct

+ type Condition struct

+ HashKey string

+ Match string

+ Rules []Rule

+ type EagleApiErr struct

+ Endpoint endpoints.Endpoint

+ Err error

+ Message string

+ func (e *EagleApiErr) Error() string

+ type EagleApiResponse struct

+ Data []interface{}

+ Status string

+ type EagleArray struct

+ Data []string

+ type EagleMessage struct

+ Data any

+ type EagleResponse struct

+ Status string

+ type Folder struct

+ Children []Folder

+ CoverID string

+ Description string

+ ID string

+ Icon string

+ IconColor string

+ ModificationTime int64

+ Name string

+ OrderBy string

+ Password string

+ PasswordTips string

+ SortIncrease bool

+ Tags []string

+ type FolderCreateResponse struct

+ ID string

+ ModificationTime int

+ Name string

+ func FolderCreate(baseUrl string, folderName string) (FolderCreateResponse, error)

+ type FolderDetailOverview struct

+ Children []string

+ DescendantImageCount int

+ Description string

+ ExtendTags []string

+ ID string

+ ImageCount int

+ Images *[]string

+ IsExpand bool

+ ModificationTime int

+ Name string

+ Password *string

+ PasswordTips *string

+ Pinyin string

+ Tags []string

+ func FolderList(baseUrl string) ([]FolderDetailOverview, error)

+ func FolderListRecent(baseUrl string) ([]FolderDetailOverview, error)

+ type FolderRenameResponse struct

+ Editable bool

+ HashKey string

+ ID string

+ IsExpand bool

+ IsVisible bool

+ ModificationTime int

+ Name string

+ NewFolderName string

+ Pinyin string

+ Size int

+ Vstype string

+ type FolderStyles struct

+ Depth int

+ First bool

+ Last bool

+ type FolderUpdateResponse struct

+ Editable bool

+ HashKey string

+ ID string

+ IsExpand bool

+ IsVisible bool

+ ModificationTime int

+ Name string

+ NewFolderName string

+ Pinyin string

+ Size int

+ Vstype string

+ type Item struct

+ Annotation string

+ FolderID string

+ ModificationTime int64

+ Name string

+ Star int

+ Tags []string

+ URL string

+ Website string

+ type ItemAddBookmarkOptions struct

+ Base64 string

+ FolderID string

+ ModificationTime string

+ Name string

+ Tags []string

+ URL string

+ type ItemAddFromPathOptions struct

+ Annotation string

+ FolderId string

+ Name string

+ Path string

+ Tags []string

+ Website string

+ type ItemAddFromUrlOptions struct

+ Annotation string

+ FolderID *string

+ Headers map[string]string

+ ModificationTime int

+ Name string

+ Star *int

+ Tags []string

+ URL string

+ Website string

+ type ItemListOptions struct

+ Ext string

+ Folders string

+ Keyword string

+ Limit int

+ Offset int

+ OrderBy string

+ Tags string

+ type ItemUpdateOptions struct

+ Annotation *string

+ ID string

+ Star *int

+ Tags *[]string

+ URL *string

+ type Library struct

+ Name string

+ Path string

+ type LibraryData struct

+ ApplicationVersion string

+ Folders []Folder

+ Library Library

+ ModificationTime int64

+ QuickAccess []QuickAccess

+ SmartFolders []SmartFolder

+ TagsGroups []TagsGroup

+ type LibraryInfoResponse struct

+ Data LibraryData

+ Status string

+ func LibraryInfo(baseURL string) (*LibraryInfoResponse, error)

+ type ListItem struct

+ Annotation string

+ Id string

+ ModificationTime int64

+ Name string

+ Tags []string

+ URL string

+ Website string

+ func ItemList(baseUrl string, opts ItemListOptions) ([]ListItem, error)

+ type Palette struct

+ Color []int

+ HashKey string

+ Ratio float64

+ type QuickAccess struct

+ ID string

+ Type string

+ type Rule struct

+ HashKey string

+ Method string

+ Property string

+ Value any

+ type SmartFolder struct

+ Conditions []Condition

+ Description string

+ ID string

+ Icon string

+ ModificationTime int64

+ Name string

+ OrderBy string

+ SortIncrease bool

+ type TagsGroup struct

+ Color string

+ ID string

+ Name string

+ Tags []string

+ type ThumbnailData struct

+ Status string

+ ThumbnailPath string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL