ouisync/org.equalitie.ouisync.lib

Package-level declarations

Types

AccessChange

sealed class AccessChange

How to change access to a repository.

AccessMode

enum AccessMode : Enum<AccessMode>

Access mode of a repository.

Callback

interface Callback : Callback

Directory

class Directory : Collection<DirectoryEntry>

A read-only snapshot of a directory stored in a Ouisync repository

DirectoryEntry

data class DirectoryEntry(val name: String, val entryType: EntryType)

A directory entry

DisableAccess

class DisableAccess : AccessChange

Disable access

EnableAccess

class EnableAccess(val secret: SetLocalSecret?) : AccessChange

Enable read or write access, optionally with local secret

EntryType

enum EntryType : Enum<EntryType>

Type of filesystem entry.

Error

class Error(val code: ErrorCode, message: String) : Exception

ErrorCode

enum ErrorCode : Enum<ErrorCode>

EventReceiver

class EventReceiver<E>

Receiver for events of type E

File

class File

A File stored in a Ouisync repository.

LocalPassword

class LocalPassword(val string: String) : LocalSecret, SetLocalSecret

Password provided by the user to set local repository access.

LocalSecret

interface LocalSecret

Type of secret to unlock a repository.

LocalSecretKey

class LocalSecretKey(val bytes: ByteArray) : LocalSecret

265-bit (32 bytes) secret key to set local repository access.

LocalSecretKeyAndSalt

class LocalSecretKeyAndSalt(val key: LocalSecretKey, val salt: PasswordSalt) : SetLocalSecret

Use to directly (without doing password hashing) set the LocalSecretKey and PasswordSalt for read or write access.

LogLevel

enum LogLevel : Enum<LogLevel>

NetworkEvent

enum NetworkEvent : Enum<NetworkEvent>

Network notification event.

PasswordSalt

class PasswordSalt(val bytes: ByteArray)

PeerInfo

data class PeerInfo(val addr: String, val source: PeerSource, val state: PeerStateKind, val runtimeId: String?)

Information about a peer.

PeerSource

enum PeerSource : Enum<PeerSource>

How was the peer discovered.

PeerStateKind

enum PeerStateKind : Enum<PeerStateKind>

State of the peer connection.

Progress

data class Progress(val value: Long, val total: Long)

Repository

class Repository

A Ouisync repository.

Session

class Session

The entry point to the ouisync library.

SessionKind

enum SessionKind : Enum<SessionKind>

What type of session to create.

SetLocalSecret

interface SetLocalSecret

Used to set or change the read or write local secret of a repository.

ShareToken

class ShareToken

A share token for a Ouisync repository.