Package org.inthewaves.kotlinsignald.clientprotocol.v1.structures

Types

AcceptInvitationRequest

common

data class AcceptInvitationRequest(account: String, groupID: String) : SignaldRequestBodyV1<AcceptInvitation, JsonGroupV2Info>

Accept a v2 group invitation.

Account

common

data class Account(address: JsonAddress?, deviceId: Int?, accountId: String?) : SignaldResponseBodyV1

A local account in signald

AccountList

common

data class AccountList(accounts: List<Account>) : SignaldResponseBodyV1

AddLinkedDeviceRequest

common

data class AddLinkedDeviceRequest(account: String, uri: String) : SignaldRequestBodyV1<AddDevice, EmptyResponse>

Link a new device to a local Signal account

AddServerRequest

common

data class AddServerRequest(server: Server) : SignaldRequestBodyV1<AddServer, String>

add a new server to connect to.

AllIdentityKeyList

common

data class AllIdentityKeyList(identityKeys: List<IdentityKeyList>) : SignaldResponseBodyV1

AnswerMessage

common

data class AnswerMessage(id: Long?, sdp: String?, opaque: String?)

ApproveMembershipRequest

common

data class ApproveMembershipRequest(account: String, groupID: String, members: List<JsonAddress>) : SignaldRequestBodyV1<ApproveMembership, JsonGroupV2Info>

approve a request to join a group

BusyMessage

common

data class BusyMessage(id: Long?)

CallMessage

common

data class CallMessage(offerMessage: OfferMessage?, answerMessage: AnswerMessage?, busyMessage: BusyMessage?, hangupMessage: HangupMessage?, iceUpdateMessage: List<IceUpdateMessage>, destinationDeviceId: Int?, multiRing: Boolean?)

Capabilities

common

data class Capabilities(gv2: Boolean?, storage: Boolean?, gv1Migration: Boolean?)

ClientMessageWrapper

common

sealed class ClientMessageWrapper

Wraps all incoming messages after a v1 subscribe request is issued Note that the type field has been removed.

CreateGroupRequest

common

data class CreateGroupRequest(account: String, title: String, avatar: String?, members: List<JsonAddress>, timer: Int?, memberRole: String?) : SignaldRequestBodyV1<CreateGroup, JsonGroupV2Info>

DeleteAccountRequest

common

data class DeleteAccountRequest(account: String, server: Boolean?) : SignaldRequestBodyV1<DeleteAccount, EmptyResponse>

delete all account data signald has on disk, and optionally delete the account from the server as well.

DeviceInfo

common

data class DeviceInfo(id: Long?, name: String?, created: Long?, lastSeen: Long?)

EmptyResponse

common

object EmptyResponse : SignaldResponseBodyV1

For requests that don't expect a response, representing {}.

ExceptionWrapper

common

data class ExceptionWrapper(version: String?, data: ExceptionWrapper.Data, error: Boolean?) : ClientMessageWrapper

An incoming message representing an error that can be sent by signald after a v1 subscribe request.

FinishLinkRequest

common

data class FinishLinkRequest(deviceName: String?, sessionId: String?) : SignaldRequestBodyV1<FinishLink, Account>

After a linking URI has been requested, finish_link must be called with the session_id provided with the URI.

GenerateLinkingURIRequest

common

data class GenerateLinkingURIRequest(server: String?) : SignaldRequestBodyV1<GenerateLinkingUri, LinkingURI>

Generate a linking URI.

GetAllIdentities

common

data class GetAllIdentities(account: String) : SignaldRequestBodyV1<GetAllIdentities, AllIdentityKeyList>

get all known identity keys

GetGroupRequest

common

data class GetGroupRequest(account: String, groupID: String, revision: Int?) : SignaldRequestBodyV1<GetGroup, JsonGroupV2Info>

Query the server for the latest state of a known group.

GetIdentitiesRequest

common

data class GetIdentitiesRequest(account: String, address: JsonAddress) : SignaldRequestBodyV1<GetIdentities, IdentityKeyList>

Get information about a known keys for a particular address

GetLinkedDevicesRequest

common

data class GetLinkedDevicesRequest(account: String) : SignaldRequestBodyV1<GetLinkedDevices, LinkedDevices>

list all linked devices on a Signal account

GetProfileRequest

common

data class GetProfileRequest(account: String, async: Boolean?, address: JsonAddress) : SignaldRequestBodyV1<GetProfile, Profile>

Get all information available about a user

GetServersRequest

common

class GetServersRequest : SignaldRequestBodyV1<GetServers, ServerList>

GroupAccessControl

common

data class GroupAccessControl(link: String?, attributes: String?, members: String?)

group access control settings.

GroupInfo

common

data class GroupInfo(v1: JsonGroupInfo?, v2: JsonGroupV2Info?) : SignaldResponseBodyV1

A generic type that is used when the group version is not known

GroupLinkInfoRequest

common

data class GroupLinkInfoRequest(account: String, uri: String) : SignaldRequestBodyV1<GroupLinkInfo, JsonGroupJoinInfo>

Get information about a group from a signal.

GroupList

common

data class GroupList(groups: List<JsonGroupV2Info>, legacyGroups: List<JsonGroupInfo>) : SignaldResponseBodyV1

GroupMember

common

data class GroupMember(uuid: String?, role: String?, joinedRevision: Int?)

HangupMessage

common

data class HangupMessage(id: Long?, type: String?, legacy: Boolean?, deviceId: Int?)

IceUpdateMessage

common

data class IceUpdateMessage(id: Long?, opaque: String?, sdp: String?)

IdentityKey

common

data class IdentityKey(added: Long?, safetyNumber: String?, qrCodeData: String?, trustLevel: String?)

IdentityKeyList

common

data class IdentityKeyList(address: JsonAddress?, identities: List<IdentityKey>) : SignaldResponseBodyV1

a list of identity keys associated with a particular address

IncomingMessage

common

data class IncomingMessage(version: String?, data: IncomingMessage.Data, error: Boolean?) : ClientMessageWrapper

JoinGroupRequest

common

data class JoinGroupRequest(account: String, uri: String) : SignaldRequestBodyV1<JoinGroup, JsonGroupJoinInfo>

Join a group using the a signal.group URL.

JsonAddress

common

data class JsonAddress(number: String?, uuid: String?, relay: String?) : SignaldResponseBodyV1

JsonBlockedListMessage

common

data class JsonBlockedListMessage(addresses: List<JsonAddress>, groupIds: List<String>)

JsonDataMessage

common

data class JsonDataMessage(timestamp: Long?, attachments: List<JsonAttachment>, body: String?, group: JsonGroupInfo?, groupV2: JsonGroupV2Info?, endSession: Boolean?, expiresInSeconds: Int?, profileKeyUpdate: Boolean?, quote: JsonQuote?, contacts: List<SharedContact>, previews: List<JsonPreview>, sticker: JsonSticker?, viewOnce: Boolean?, reaction: JsonReaction?, remoteDelete: RemoteDelete?, mentions: List<JsonMention>, payment: Payment?, groupCallUpdate: String?)

JsonGroupInfo

common

data class JsonGroupInfo(groupId: String?, members: List<JsonAddress>, name: String?, type: String?, avatarId: Long?)

information about a legacy group

JsonGroupJoinInfo

common

data class JsonGroupJoinInfo(groupID: String?, title: String?, memberCount: Int?, addFromInviteLink: Int?, revision: Int?, pendingAdminApproval: Boolean?) : SignaldResponseBodyV1

JsonGroupV2Info

common

data class JsonGroupV2Info(id: String?, revision: Int?, title: String?, description: String?, avatar: String?, timer: Int?, members: List<JsonAddress>, pendingMembers: List<JsonAddress>, requestingMembers: List<JsonAddress>, inviteLink: String?, accessControl: GroupAccessControl?, memberDetail: List<GroupMember>, pendingMemberDetail: List<GroupMember>) : SignaldResponseBodyV1

Information about a Signal group

JsonMention

common

data class JsonMention(uuid: String?, start: Int?, length: Int?)

JsonMessageEnvelope

common

data class JsonMessageEnvelope(username: String?, uuid: String?, source: JsonAddress?, sourceDevice: Int?, type: String?, relay: String?, timestamp: Long?, timestampISO: String?, serverTimestamp: Long?, serverDeliveredTimestamp: Long?, hasLegacyMessage: Boolean?, hasContent: Boolean?, isUnidentifiedSender: Boolean?, dataMessage: JsonDataMessage?, syncMessage: JsonSyncMessage?, callMessage: JsonCallMessage?, receipt: JsonReceiptMessage?, typing: JsonTypingMessage?)

JsonMessageRequestResponseMessage

common

data class JsonMessageRequestResponseMessage(person: JsonAddress?, groupId: String?, type: String?)

JsonQuote

common

data class JsonQuote(id: Long?, author: JsonAddress?, text: String?, attachments: List<JsonQuotedAttachment>, mentions: List<JsonMention>)

A quote is a reply to a previous message.

JsonReaction

common

data class JsonReaction(emoji: String?, remove: Boolean?, targetAuthor: JsonAddress?, targetSentTimestamp: Long?)

JsonReadMessage

common

data class JsonReadMessage(sender: JsonAddress?, timestamp: Long?)

JsonSendMessageResult

common

data class JsonSendMessageResult(address: JsonAddress?, success: Success?, networkFailure: Boolean?, unregisteredFailure: Boolean?, identityFailure: String?)

JsonSentTranscriptMessage

common

data class JsonSentTranscriptMessage(destination: JsonAddress?, timestamp: Long?, expirationStartTimestamp: Long?, message: JsonDataMessage?, unidentifiedStatus: Map<String, Boolean>?, isRecipientUpdate: Boolean?)

JsonSyncMessage

common

data class JsonSyncMessage(sent: JsonSentTranscriptMessage?, contacts: JsonAttachment?, contactsComplete: Boolean?, groups: JsonAttachment?, blockedList: JsonBlockedListMessage?, request: String?, readMessages: List<JsonReadMessage>, viewOnceOpen: JsonViewOnceOpenMessage?, verified: JsonVerifiedMessage?, configuration: ConfigurationMessage?, stickerPackOperations: List<JsonStickerPackOperationMessage>, fetchType: String?, messageRequestResponse: JsonMessageRequestResponseMessage?)

JsonVerifiedMessage

common

data class JsonVerifiedMessage(destination: JsonAddress?, identityKey: String?, verified: String?, timestamp: Long?)

JsonVersionMessage

common

data class JsonVersionMessage(name: String?, version: String?, branch: String?, commit: String?) : SignaldResponseBodyV1

JsonViewOnceOpenMessage

common

data class JsonViewOnceOpenMessage(sender: JsonAddress?, timestamp: Long?)

LeaveGroupRequest

common

data class LeaveGroupRequest(account: String, groupID: String) : SignaldRequestBodyV1<LeaveGroup, GroupInfo>

LinkedDevices

common

data class LinkedDevices(devices: List<DeviceInfo>) : SignaldResponseBodyV1

LinkingURI

common

data class LinkingURI(uri: String?, sessionId: String?) : SignaldResponseBodyV1

ListAccountsRequest

common

class ListAccountsRequest : SignaldRequestBodyV1<ListAccounts, AccountList>

return all local accounts

ListContactsRequest

common

data class ListContactsRequest(account: String, async: Boolean?) : SignaldRequestBodyV1<ListContacts, ProfileList>

ListenerState

common

data class ListenerState(version: String?, data: ListenerState.Data, error: Boolean?) : ClientMessageWrapper

indicates when the incoming connection to the signal server has started or stopped

ListGroupsRequest

common

data class ListGroupsRequest(account: String) : SignaldRequestBodyV1<ListGroups, GroupList>

MarkReadRequest

common

data class MarkReadRequest(account: String, to: JsonAddress, timestamps: List<Long>, when: Long?) : SignaldRequestBodyV1<MarkRead, EmptyResponse>

OfferMessage

common

data class OfferMessage(id: Long?, sdp: String?, type: String?, opaque: String?)

Payment

common

data class Payment(receipt: String?, note: String?)

details about a MobileCoin payment

Profile

common

data class Profile(name: String?, avatar: String?, address: JsonAddress?, capabilities: Capabilities?, color: String?, about: String?, emoji: String?, profileName: String?, inboxPosition: Int?, expirationTime: Int?, mobilecoinAddress: String?) : SignaldResponseBodyV1

Information about a Signal user

ProfileList

common

data class ProfileList(profiles: List<Profile>) : SignaldResponseBodyV1

ReactRequest

common

data class ReactRequest(username: String, recipientAddress: JsonAddress?, recipientGroupId: String?, reaction: JsonReaction, timestamp: Long?) : SignaldRequestBodyV1<React, SendResponse>

react to a previous message

ReceiptMessage

common

data class ReceiptMessage(type: String?, timestamps: List<Long>, when: Long?)

RegisterRequest

common

data class RegisterRequest(account: String, voice: Boolean?, captcha: String?, server: String?) : SignaldRequestBodyV1<Register, Account>

begin the account registration process by requesting a phone number verification code.

RemoteDelete

common

data class RemoteDelete(targetSentTimestamp: Long?)

RemoteDeleteRequest

common

data class RemoteDeleteRequest(account: String, address: JsonAddress?, group: String?, timestamp: Long) : SignaldRequestBodyV1<RemoteDelete, SendResponse>

delete a message previously sent

RemoveLinkedDeviceRequest

common

data class RemoveLinkedDeviceRequest(account: String, deviceId: Long) : SignaldRequestBodyV1<RemoveLinkedDevice, EmptyResponse>

Remove a linked device from the Signal account.

RemoveServerRequest

common

data class RemoveServerRequest(uuid: String?) : SignaldRequestBodyV1<DeleteServer, EmptyResponse>

RequestSyncRequest

common

data class RequestSyncRequest(account: String, groups: Boolean?, configuration: Boolean?, contacts: Boolean?, blocked: Boolean?) : SignaldRequestBodyV1<RequestSync, EmptyResponse>

Request other devices on the account send us their group list, syncable config and contact list.

ResetSessionRequest

common

data class ResetSessionRequest(account: String, address: JsonAddress, timestamp: Long?) : SignaldRequestBodyV1<ResetSession, SendResponse>

reset a session with a particular user

ResolveAddressRequest

common

data class ResolveAddressRequest(account: String, partial: JsonAddress) : SignaldRequestBodyV1<ResolveAddress, JsonAddress>

Resolve a partial JsonAddress with only a number or UUID to one with both.

SendPaymentRequest

common

data class SendPaymentRequest(account: String, address: JsonAddress, payment: Payment, when: Long?) : SignaldRequestBodyV1<SendPayment, SendResponse>

send a mobilecoin payment

SendRequest

common

data class SendRequest(username: String, recipientAddress: JsonAddress?, recipientGroupId: String?, messageBody: String?, attachments: List<JsonAttachment>, quote: JsonQuote?, timestamp: Long?, mentions: List<JsonMention>) : SignaldRequestBodyV1<Send, SendResponse>

SendResponse

common

data class SendResponse(results: List<JsonSendMessageResult>, timestamp: Long?) : SignaldResponseBodyV1

Server

common

data class Server(uuid: String?, proxy: String?, ca: String?, serviceUrl: String?, cdnUrls: List<ServerCDN>, contactDiscoveryUrl: String?, keyBackupUrl: String?, storageUrl: String?, zkParam: String?, unidentifiedSenderRoot: String?)

a Signal server

ServerCDN

common

data class ServerCDN(number: Int?, url: String?)

ServerList

common

data class ServerList(servers: List<Server>) : SignaldResponseBodyV1

SetDeviceNameRequest

common

data class SetDeviceNameRequest(account: String, deviceName: String?) : SignaldRequestBodyV1<SetDeviceName, EmptyResponse>

set this device's name.

SetExpirationRequest