0.9.2-2

ouisync-session/org.equalitie.ouisync.session/Repository

Repository

open class Repository

Types

object Companion

Functions

suspend fun close()

Closes the repository.

createDirectory

suspend fun createDirectory(path: String)

Creates a new directory at the given path in the repository.

suspend fun createFile(path: String): File

Creates a new file at the given path in the repository.

suspend fun createMirror(host: String)

Creates mirror of this repository on the given cache server host.

suspend fun delete()

Delete the repository

suspend fun deleteMirror(host: String)

Deletes mirror of this repository from the given cache server host.

open operator override fun equals(other: Any?): Boolean

suspend fun export(outputPath: String): String

Export repository to file

suspend fun fileExists(path: String): Boolean

suspend fun getAccessMode(): AccessMode

Returns the access mode (blind, read or write) the repository is currently opened in.

getBlockExpiration

suspend fun getBlockExpiration(): Duration?

suspend fun getCredentials(): ByteArray

Gets the current credentials of this repository. Can be used to restore access after closing and reopening the repository.

suspend fun getEntryType(path: String): EntryType?

Returns the type of repository entry (file, directory, ...) or None if the entry doesn't exist.

suspend fun getExpiration(): Duration?

suspend fun getInfoHash(): String

Return the info-hash of the repository formatted as hex string. This can be used as a globally unique, non-secret identifier of the repository.

suspend fun getMetadata(key: String): String?

suspend fun getMountPoint(): String?

suspend fun getPath(): String

suspend fun getQuota(): QuotaInfo

suspend fun getShortName(): String

suspend fun getStats(): Stats

getSyncProgress

suspend fun getSyncProgress(): Progress

Returns the synchronization progress of this repository as the number of bytes already synced (Progress.value) vs. the total size of the repository in bytes (Progress.total).

open override fun hashCode(): Int

suspend fun isDhtEnabled(): Boolean

Is Bittorrent DHT enabled?

suspend fun isPexEnabled(): Boolean

Is Peer Exchange enabled?

suspend fun isSyncEnabled(): Boolean

Returns whether syncing with other replicas is enabled for this repository.

suspend fun mirrorExists(host: String): Boolean

Checks if this repository is mirrored on the given cache server host.

suspend fun mount(): String

suspend fun move(dst: String)

suspend fun moveEntry(src: String, dst: String)

Moves an entry (file or directory) from src to dst.

suspend fun openFile(path: String): File

Opens an existing file at the given path in the repository.

suspend fun readDirectory(path: String): List<DirectoryEntry>

Returns the entries of the directory at the given path in the repository.

removeDirectory

suspend fun removeDirectory(path: String, recursive: Boolean = false)

Removes the directory at the given path from the repository. If recursive is true it removes also the contents, otherwise the directory must be empty.

suspend fun removeFile(path: String)

Removes (deletes) the file at the given path from the repository.

suspend fun resetAccess(token: ShareToken)

suspend fun setAccess(read: AccessChange?, write: AccessChange?)

Sets, unsets or changes local secrets for accessing the repository or disables the given access mode.

suspend fun setAccessMode(accessMode: AccessMode, localSecret: LocalSecret? = null)

Switches the repository to the given access mode.

setBlockExpiration

suspend fun setBlockExpiration(value: Duration?)

suspend fun setCredentials(credentials: ByteArray)

Sets the current credentials of the repository.

suspend fun setDhtEnabled(enabled: Boolean)

Enables/disabled Bittorrent DHT (for peer discovery).

suspend fun setExpiration(value: Duration?)

suspend fun setMetadata(edits: List<MetadataEdit>): Boolean

suspend fun setPexEnabled(enabled: Boolean)

Enables/disables Peer Exchange (for peer discovery).

suspend fun setQuota(value: StorageSize?)

suspend fun setSyncEnabled(enabled: Boolean)

Enabled or disables syncing with other replicas.

suspend fun share(accessMode: AccessMode, localSecret: LocalSecret? = null): ShareToken

Creates a share token to share this repository with other devices.

fun Repository.subscribe(): Flow<Unit>

Subscribe to repository events.

open override fun toString(): String

suspend fun unmount()