Package org.inthewaves.kotlinsignald

Types

Used with the org.inthewaves.kotlinsignald.Signal.updateGroup function inside of GroupUpdate. A class to enforce that only one of the access controls are updated at once.

AccessRequired

enum AccessRequired : Enum<AccessRequired>

Used with the org.inthewaves.kotlinsignald.Signal.updateGroup function.

Fingerprint

sealed class Fingerprint

Used with the org.inthewaves.kotlinsignald.Signal.trust function.

GroupLinkStatus

enum GroupLinkStatus : Enum<GroupLinkStatus>

Used with the org.inthewaves.kotlinsignald.Signal.updateGroup function.

GroupUpdate

interface GroupUpdate

Used with the org.inthewaves.kotlinsignald.Signal.updateGroup function. This is a class to enforce that only one of the group attributes are updated at once.

IncomingMessageSubscription

interface IncomingMessageSubscription : AutoCloseable

Represents an active incoming message subscription with signald.

LeaveGroupType

enum LeaveGroupType : Enum<LeaveGroupType>

Used with the org.inthewaves.kotlinsignald.Signal.leaveGroup function.

NodePersistentSocketWrapper

class NodePersistentSocketWrapper : SuspendSocketCommunicator

NodeSocketWrapper

class NodeSocketWrapper : SuspendSocketCommunicator

PersistentSocketWrapper

expect class PersistentSocketWrapper : SocketCommunicator

A wrapper for a socket that maintains a socket connection for every request, ideal for receiving chat messages after a subscribe request.

RateLimitChallenge

sealed class RateLimitChallenge

Used with the org.inthewaves.kotlinsignald.Signal.submitChallenge function. Specifies a submission to a rate limit challenge issued by the server.

Recipient

sealed class Recipient

Specifies a recipient type for functions that can send to either type (e.g., org.inthewaves.kotlinsignald.Signal.react, org.inthewaves.kotlinsignald.Signal.remoteDelete, org.inthewaves.kotlinsignald.Signal.send, org.inthewaves.kotlinsignald.Signal.setExpiration, org.inthewaves.kotlinsignald.Signal.typing). Recipients are either to a Group or an Individual (or Self for Note to Self).

Signal

expect class Signal : SignaldClient

actual class Signal : SignaldClient

An asynchronous signald client, for use with V1 of the signald protocol. Use the create function to create an instance.

actual class Signal constructor(accountId: String, socketPath: String?) : SignaldClient

A synchronous signald client, for use with V1 of the signald protocol. Note that the functions and the constructor can block the thread that called the function / constructor due to reads and writes responses from a UNIX socket via blocking method calls.

SignaldClient

interface SignaldClient

Represents a client able to communicate with a signald socket.

SocketUnavailableException

class SocketUnavailableException : SignaldException

SocketWrapper

expect class SocketWrapper : SocketCommunicator

A wrapper for a socket that makes new socket connections for every request and closes the connection after a request. making it thread safe.

SyncRequest

sealed class SyncRequest

Used with the org.inthewaves.kotlinsignald.Signal.sendSyncRequest function for SendSyncMessageRequest to send sync requests to other devices.

TrustLevel

enum TrustLevel : Enum<TrustLevel>

Used with the org.inthewaves.kotlinsignald.Signal.trust function.