Represents a message which holds either a PluginMessage or a NonSignalMessage. It's main purpose is to extend Message to support a model where it is convenient to transfer non-signal compliant messages.

Message

data class Message(val messageType: MessageType, val sourceUuid: UUID, val sourceMsisdn: Msisdn, val sourceDeviceId: Int, val destination: UUID, val destinationDeviceId: Int, val destinationRegistrationId: RegistrationId, val content: String, val timestamp: Long)

Represents the message-dto, which a server-client sends.

MessageType

enum MessageType : Enum<MessageType>

Defines types of messages.

MessageWithId

data class MessageWithId(val id: Int, val message: Message)

Represents a wrapper around message-dto with it's assigned id from the database.

NonSignalMessage

data class NonSignalMessage(val text: String)

Represents a non-signal compliant message.

OneTimeKey

data class OneTimeKey(val keyId: Long, val publicKey: String)

Represents a signal-compliant OneTimeKey. It is used to allow both parties to agree on Bob's ratchet public key.

PlatformPlugin

typealias PlatformPlugin = Plugin

Defines an installable Plugin.

Plugin

data class Plugin(val id: String)

Defines a plugin. Plugins can extend this message to support their own model.

PluginMessage

data class PluginMessage(val plugin: Plugin, val text: String)

Represents a plugin message. Plugins are expected to extend this message to support their own model. By extension, this means it is required for plugin's model to be known beforehand.

ReceiptMessage

data class ReceiptMessage(val type: ReceiptType)

Represents a receipt message. Through this type of message source can be notified if the message has been read (or not).

ReceiptType

enum ReceiptType : Enum<ReceiptType>

Defines different types of ReceiptMessage. Types represent different stages of message's state.

RegisterAccount

data class RegisterAccount(val msisdn: Msisdn, val name: String, val registrationId: RegistrationId)

Represents the account of the end-user's with its RegistrationId.

RejectedMessage

data class RejectedMessage(val id: Int, val rejectionDetails: RejectionDetails)

Represents a rejected message's id with the rejectionDetails.

RejectedReason

enum RejectedReason : Enum<RejectedReason>

Defines reasons why the message was rejected and specifies whether the operation is retryable or not and under which conditions.

RejectionDetails

data class RejectionDetails(val reason: RejectedReason, val cause: String)

Contains the cause and reason of the message's rejection.

ReplaceMasterDeviceRequest

data class ReplaceMasterDeviceRequest(val msisdn: Msisdn, val registrationId: RegistrationId)

The request to replace master device.

ServerClientUpdateResponse

enum ServerClientUpdateResponse : Enum<ServerClientUpdateResponse>

Represents the response dto when updating server-client's configuration.

SessionInitDeviceKeyBundle

data class SessionInitDeviceKeyBundle(val deviceId: Int, val registrationId: RegistrationId, val signedPreKey: SignedPreKey, val oneTimeKey: OneTimeKey?)

Represents a key-bundle which is used to return all the necessary keys for the session's (ratchet) initialization.

SetupDeviceKeyBundle

data class SetupDeviceKeyBundle(val accountUuid: UUID, val identityKey: String, val deviceId: Int, val signedPreKey: SignedPreKey, val oneTimeKeys: List<OneTimeKey> = emptyList())

Represents the key-bundle which the device is setting during the set-up-device phase.

SignedPreKey

data class SignedPreKey(val keyId: Long, val publicKey: String, val signature: String)

Represents a signal-compliant SignedPreKey.

SourceServerType

enum SourceServerType : Enum<SourceServerType>

Defines types of source server.

Type

data class Type(val sourceServerType: SourceServerType, val messageType: MessageType)

Defines a union between source server type and the message's type. Based on this union the consumer can decide the serialization strategy.

TypingMessage

enum TypingMessage : Enum<TypingMessage>

Represents a typing message. This message can be used by clients to enable typing animation.

UpdateServerClientRequest

data class UpdateServerClientRequest

Represents the request dto to update the server-client's configuration.

Version

enum Version : Enum<Version>

Message's version, through this number is expressed the message's compatibility. Any increment on this number represents a non-backwards compatibility change.

Functions

accountFrom

@JvmName(name = "from")

fun accountFrom(uuid: UUID, msisdn: String, name: String): Account

A factory function for creating an Account.

contactFrom

@JvmName(name = "from")

fun contactFrom(uuid: UUID, msisdn: String): Contact

A factory function for creating a Contact.

createReplaceMasterRequest

@JvmName(name = "from")

fun createReplaceMasterRequest(msisdn: String, registrationId: Int): ReplaceMasterDeviceRequest

A factory function for creating a ReplaceMasterDeviceRequest.

deviceFrom

@JvmName(name = "from")

fun deviceFrom(accountUuid: UUID, registrationId: Int): Device

A factory function for creating a Device.

messageFrom

@JvmName(name = "from")

fun messageFrom(messageTypeTag: Int, sourceUuid: UUID, sourceMsisdn: String, sourceDeviceId: Int, destination: UUID, destinationDeviceId: Int, destinationRegistrationId: Int, content: String, timestamp: Long): Message

A factory function for creating a Message.

registerAccountFrom

@JvmName(name = "from")

fun registerAccountFrom(msisdn: String, name: String, registrationId: Int): RegisterAccount

A factory function for creating an RegisterAccount.

sessionInitDeviceKeyFrom

@JvmName(name = "createSessionInitDeviceKey")

fun sessionInitDeviceKeyFrom(deviceId: Int, registrationId: Int, signedPreKey: SignedPreKey, oneTimeKey: OneTimeKey?): SessionInitDeviceKeyBundle

A factory function for creating SessionInitDeviceKeyBundle.

toAccount

@JvmName(name = "from")

fun RegisterAccount.toAccount(uuid: UUID): Account

Converts this RegisterAccount to an Account.

UpdateServerClientRequest

fun UpdateServerClientRequest(key: ServerKey, serverClientConfig: ServerClientConfig, jwt: String): UpdateServerClientRequest

fun UpdateServerClientRequest(serverKeyAsString: String, serverClientConfigAsString: String, jwt: String): UpdateServerClientRequest

A factory function for creating an UpdateServerClientRequest.