api

Documentation

Overview

Package api provides interface for the Evernote API.

Index

• type Notestore

Types

type Notestore

type Notestore interface {
	// ListNotebooks returns a list of all the user's notebooks.
	ListNotebooks(apiKey string) (r []*types.Notebook, err error)
	// CreateNotebook creates a new notebook for the user.
	CreateNotebook(apiKey string, notebook *types.Notebook) (r *types.Notebook, err error)
	// UpdateNotebook sends an updated notebook to the server.
	UpdateNotebook(apiKey string, notebook *types.Notebook) (r int32, err error)
	// GetNotebook returns a notebook from the notestore.
	GetNotebook(authenticationToken string, guid types.GUID) (r *types.Notebook, err error)
	// CreateNote creates a new note on the server.
	CreateNote(apiKey string, note *types.Note) (r *types.Note, err error)
	// DeleteNote moves a note to the trash can.
	DeleteNote(apiKey string, guid types.GUID) (int32, error)
	// UpdateNote submits a set of changes to a note to the service.  The provided data
	// must include the note's guid field for identification. The note's title must also be set.
	UpdateNote(authenticationToken string, note *types.Note) (r *types.Note, err error)
	// FindNotes searches the server and returns notes matching the filter.
	FindNotes(apiKey string, filter *notestore.NoteFilter, offset int32, maxNumNotes int32) (r *notestore.NoteList, err error)
	// GetNoteContent returns XHTML contents of the note with the provided GUID.
	// If the Note is found in a public notebook, the authenticationToken will be ignored (so it could be an empty string).
	GetNoteContent(authenticationToken string, guid types.GUID) (r string, err error)
}

Notestore is the API interface for the notestore client.