| Copyright | (c) 2014 Jens Thomas |
|---|---|
| License | BSD-style |
| Maintainer | jetho@gmx.de |
| Stability | experimental |
| Portability | GHC |
| Safe Haskell | None |
| Language | Haskell2010 |
| Extensions |
|
Network.Syncthing.Get
Contents
Description
Syncthing GET requests.
- ping :: MonadSync m => SyncM m Text
- apiKey :: MonadSync m => SyncM m (Maybe Text)
- config :: MonadSync m => SyncM m Config
- completion :: MonadSync m => Device -> FolderName -> SyncM m Int
- connections :: MonadSync m => SyncM m (Map Device Connection)
- deviceId :: MonadSync m => Device -> SyncM m Device
- discovery :: MonadSync m => SyncM m (Map Device [CacheEntry])
- errors :: MonadSync m => SyncM m [Error]
- ignores :: MonadSync m => FolderName -> SyncM m Ignore
- model :: MonadSync m => FolderName -> SyncM m Model
- need :: MonadSync m => FolderName -> SyncM m Need
- report :: MonadSync m => SyncM m UsageReport
- sync :: MonadSync m => SyncM m Bool
- system :: MonadSync m => SyncM m System
- tree :: MonadSync m => FolderName -> Maybe Path -> Maybe Int -> SyncM m (Maybe DirTree)
- upgrade :: MonadSync m => SyncM m Upgrade
- version :: MonadSync m => SyncM m Version
Request functions
completion :: MonadSync m => Device -> FolderName -> SyncM m Int Source
Return the completion percentage (0 to 100) for a given device and folder.
connections :: MonadSync m => SyncM m (Map Device Connection) Source
Get the list of current connections and some metadata associated with the connection/peer.
deviceId :: MonadSync m => Device -> SyncM m Device Source
Verifiy and format a device ID. Return either a valid device ID in modern format, or an error.
discovery :: MonadSync m => SyncM m (Map Device [CacheEntry]) Source
Fetch the contents of the local discovery cache.
model :: MonadSync m => FolderName -> SyncM m Model Source
Get information about the current status of a folder.
need :: MonadSync m => FolderName -> SyncM m Need Source
Get lists of files which are needed by this device in order for it to become in sync.
report :: MonadSync m => SyncM m UsageReport Source
Returns the data sent in the anonymous usage report.
system :: MonadSync m => SyncM m System Source
Returns information about current system status and resource usage.
Arguments
| :: MonadSync m | |
| => FolderName | root folder |
| -> Maybe Path | defines a prefix within the tree where to start building the structure |
| -> Maybe Int | defines how deep within the tree we want to dwell down (0 based, defaults to unlimited depth) |
| -> SyncM m (Maybe DirTree) |
Get the directory tree of the global model.