Documentation
¶
Index ¶
- func DocumentsFileTree(http *transport.HttpClientCtx) (*filetree.FileTreeCtx, error)
- type ApiCtx
- func (ctx *ApiCtx) CreateDir(parentId, name string, notify bool) (*model.Document, error)
- func (ctx *ApiCtx) DeleteEntry(node *model.Node) error
- func (ctx *ApiCtx) FetchDocument(docId, dstPath string) error
- func (ctx *ApiCtx) Filetree() *filetree.FileTreeCtx
- func (ctx *ApiCtx) MoveEntry(src, dstDir *model.Node, name string) (*model.Node, error)
- func (ctx *ApiCtx) Nuke() error
- func (ctx *ApiCtx) Refresh() (err error)
- func (ctx *ApiCtx) SyncComplete() error
- func (ctx *ApiCtx) UploadDocument(parentId string, sourceDocPath string, notify bool) (*model.Document, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DocumentsFileTree ¶
func DocumentsFileTree(http *transport.HttpClientCtx) (*filetree.FileTreeCtx, error)
DocumentsFileTree reads your remote documents and builds a file tree structure to represent them
Types ¶
type ApiCtx ¶
type ApiCtx struct {
Http *transport.HttpClientCtx
// contains filtered or unexported fields
}
An ApiCtx allows you interact with the remote reMarkable API
func (*ApiCtx) CreateDir ¶
CreateDir creates a remote directory with a given name under the parentId directory
func (*ApiCtx) DeleteEntry ¶
DeleteEntry removes an entry: either an empty directory or a file
func (*ApiCtx) FetchDocument ¶
FetchDocument downloads a document given its ID and saves it locally into dstPath
func (*ApiCtx) Filetree ¶
func (ctx *ApiCtx) Filetree() *filetree.FileTreeCtx
func (*ApiCtx) MoveEntry ¶
MoveEntry moves an entry (either a directory or a file) - src is the source node to be moved - dstDir is an existing destination directory - name is the new name of the moved entry in the destination directory
func (*ApiCtx) SyncComplete ¶ added in v0.0.19
SyncComplete does nothing for this version
Source Files
Click to show internal directories.
Click to hide internal directories.