summaryrefslogtreecommitdiffstats
path: root/lib/folder/folder-interface.go
diff options
context:
space:
mode:
authorSebastien Douheret <sebastien.douheret@iot.bzh>2017-11-29 08:54:00 +0100
committerSebastien Douheret <sebastien.douheret@iot.bzh>2017-11-29 11:10:30 +0100
commit2f7828d01f4c4ca2909f95f098627cd5475ed225 (patch)
treeb5e71920b813b95cae3e32044be08b99223348ec /lib/folder/folder-interface.go
parent5caebfb4b7c3b73988f067082b219ce5b7f409ba (diff)
Refit source files to have a public xs-apiv1 lib package.
Signed-off-by: Sebastien Douheret <sebastien.douheret@iot.bzh>
Diffstat (limited to 'lib/folder/folder-interface.go')
-rw-r--r--lib/folder/folder-interface.go80
1 files changed, 0 insertions, 80 deletions
diff --git a/lib/folder/folder-interface.go b/lib/folder/folder-interface.go
deleted file mode 100644
index 3208869..0000000
--- a/lib/folder/folder-interface.go
+++ /dev/null
@@ -1,80 +0,0 @@
-package folder
-
-// FolderType definition
-type FolderType string
-
-const (
- TypePathMap = "PathMap"
- TypeCloudSync = "CloudSync"
- TypeCifsSmb = "CIFS"
-)
-
-// Folder Status definition
-const (
- StatusErrorConfig = "ErrorConfig"
- StatusDisable = "Disable"
- StatusEnable = "Enable"
- StatusPause = "Pause"
- StatusSyncing = "Syncing"
-)
-
-type EventCBData map[string]interface{}
-type EventCB func(cfg *FolderConfig, data *EventCBData)
-
-// IFOLDER Folder interface
-type IFOLDER interface {
- NewUID(suffix string) string // Get a new folder UUID
- Add(cfg FolderConfig) (*FolderConfig, error) // Add a new folder
- GetConfig() FolderConfig // Get folder public configuration
- GetFullPath(dir string) string // Get folder full path
- ConvPathCli2Svr(s string) string // Convert path from Client to Server
- ConvPathSvr2Cli(s string) string // Convert path from Server to Client
- Remove() error // Remove a folder
- Update(cfg FolderConfig) (*FolderConfig, error) // Update a new folder
- RegisterEventChange(cb *EventCB, data *EventCBData) error // Request events registration (sent through WS)
- UnRegisterEventChange() error // Un-register events
- Sync() error // Force folder files synchronization
- IsInSync() (bool, error) // Check if folder files are in-sync
-}
-
-// FolderConfig is the config for one folder
-type FolderConfig struct {
- ID string `json:"id"`
- Label string `json:"label"`
- ClientPath string `json:"path"`
- Type FolderType `json:"type"`
- Status string `json:"status"`
- IsInSync bool `json:"isInSync"`
- DefaultSdk string `json:"defaultSdk"`
- ClientData string `json:"clientData"` // free form field that can used by client
-
- // Not exported fields from REST API point of view
- RootPath string `json:"-"`
-
- // FIXME: better to define an equivalent to union data and then implement
- // UnmarshalJSON/MarshalJSON to decode/encode according to Type value
- // Data interface{} `json:"data"`
-
- // Specific data depending on which Type is used
- DataPathMap PathMapConfig `json:"dataPathMap,omitempty"`
- DataCloudSync CloudSyncConfig `json:"dataCloudSync,omitempty"`
-}
-
-// FolderConfigUpdatableFields List fields that can be updated using Update function
-var FolderConfigUpdatableFields = []string{
- "Label", "DefaultSdk", "ClientData",
-}
-
-// PathMapConfig Path mapping specific data
-type PathMapConfig struct {
- ServerPath string `json:"serverPath"`
-
- // Don't keep temporary file name (IOW we don't want to save it and reuse it)
- CheckFile string `json:"checkFile" xml:"-"`
- CheckContent string `json:"checkContent" xml:"-"`
-}
-
-// CloudSyncConfig CloudSync (AKA Syncthing) specific data
-type CloudSyncConfig struct {
- SyncThingID string `json:"syncThingID"`
-}