`aiosignald.generated`

Generated using https://signald.org/protocol.json Version: ‘0.23.2-7-1583b4df’=

Module Contents

Classes

`JsonAccountListv0`
`JsonMessageEnvelopev0`
`JsonAccountv0`
`JsonAddressv0`
`JsonDataMessagev0`
`JsonSyncMessagev0`
`JsonCallMessagev0`
`JsonReceiptMessagev0`
`JsonTypingMessagev0`
`JsonAttachmentv0`
`JsonGroupInfov0`
`JsonGroupV2Infov0`
`JsonQuotev0`	A quote is a reply to a previous message. ID is the sent time of the message being replied to
`SharedContactv0`
`JsonPreviewv0`
`JsonStickerv0`
`JsonReactionv0`
`RemoteDeletev0`
`JsonMentionv0`
`JsonSentTranscriptMessagev0`
`JsonBlockedListMessagev0`
`JsonReadMessagev0`
`JsonViewOnceOpenMessagev0`
`JsonVerifiedMessagev0`
`ConfigurationMessagev0`
`JsonStickerPackOperationMessagev0`
`OfferMessagev0`
`AnswerMessagev0`
`BusyMessagev0`
`HangupMessagev0`
`IceUpdateMessagev0`
`JsonQuotedAttachmentv0`
`GroupAccessControlv0`	group access control settings. Options for each controlled action are: UNKNOWN, ANY, MEMBER, ADMINISTRATOR, UNSATISFIABLE and UNRECOGNIZED
`GroupMemberv0`
`Namev0`
`Optionalv0`
`Typev0`
`ClientMessageWrapperv1`	Wraps all incoming messages sent to the client after a v1 subscribe request is issued
`IncomingMessagev1`
`ListenerStatev1`	prior attempt to indicate signald connectivity state. WebSocketConnectionState messages will be delivered at the same time as well as in other parts of the websocket lifecycle.
`WebSocketConnectionStatev1`	indicates when the websocket connection state to the signal server has changed
`StorageChangev1`	Broadcast to subscribed clients when there is a state change from the storage service
`SendResponsev1`
`JsonVersionMessagev1`
`JsonGroupV2Infov1`	Information about a Signal group
`LinkedDevicesv1`
`JsonGroupJoinInfov1`
`GroupInfov1`	A generic type that is used when the group version is not known
`SetProfilev1`
`JsonAddressv1`
`Profilev1`	Information about a Signal user
`GroupListv1`
`ProfileListv1`
`LinkingURIv1`
`Accountv1`	A local account in signald
`IdentityKeyListv1`	a list of identity keys associated with a particular address
`AccountListv1`
`GetAllIdentitiesv1`	get all known identity keys
`AllIdentityKeyListv1`
`ServerListv1`
`RemoteConfigListv1`
`BooleanMessagev1`	A message containing a single boolean, usually as a response
`GroupHistoryPagev1`	The result of fetching a group's history along with paging data.
`JsonSendMessageResultv1`
`IdentityKeyv1`
`JsonDataMessagev1`
`JsonSyncMessagev1`
`CallMessagev1`
`ReceiptMessagev1`
`TypingMessagev1`
`StoryMessagev1`
`DecryptionErrorMessagev1`
`JsonAttachmentv1`	represents a file attached to a message. When sending, only filename is required.
`JsonQuotev1`	A quote is a reply to a previous message. ID is the sent time of the message being replied to
`JsonMentionv1`
`JsonPreviewv1`	metadata about one of the links in a message
`JsonReactionv1`
`GroupAccessControlv1`	group access control settings. Options for each controlled action are: UNKNOWN, ANY, MEMBER, ADMINISTRATOR, UNSATISFIABLE and UNRECOGNIZED
`GroupMemberv1`
`BannedGroupMemberv1`
`GroupChangev1`	Represents a group change made by a user. This can also represent request link invites. Only the fields relevant to the group change performed will be set. Note that in signald, group changes are currently only received from incoming messages from a message subscription.
`DeviceInfov1`
`JsonGroupInfov1`	information about a legacy group
`Capabilitiesv1`
`Serverv1`	a Signal server
`Paymentv1`	details about a MobileCoin payment
`RemoteConfigv1`	A remote config (feature flag) entry.
`GroupHistoryEntryv1`
`PagingDatav1`
`JsonViewOnceOpenMessagev1`
`SendSuccessv1`
`SharedContactv1`
`RemoteDeletev1`
`StoryContextv1`
`JsonSentTranscriptMessagev1`
`JsonBlockedListMessagev1`
`JsonReadMessagev1`
`JsonVerifiedMessagev1`
`OfferMessagev1`
`AnswerMessagev1`
`BusyMessagev1`
`HangupMessagev1`
`IceUpdateMessagev1`
`TextAttachmentv1`
`GroupPendingMemberv1`
`ServerCDNv1`
`SharedContactNamev1`
`SharedContactEmailv1`
`SharedContactPhonev1`
`SharedContactAddressv1`
`SharedContactAvatarv1`
`Gradientv1`
`SignaldGeneratedAPI`	Interface for stream protocol.

class aiosignald.generated.JsonAccountListv0

accounts: list[JsonAccountv0]

class aiosignald.generated.JsonMessageEnvelopev0

username: str | None

uuid: str | None

source: JsonAddressv0 | None

sourceDevice: int | None

type: str | None

relay: str | None

timestamp: int | None

timestampISO: str | None

serverTimestamp: int | None

serverDeliveredTimestamp: int | None

hasLegacyMessage: bool | None

hasContent: bool | None

isUnidentifiedSender: bool | None

dataMessage: JsonDataMessagev0 | None

syncMessage: JsonSyncMessagev0 | None

callMessage: JsonCallMessagev0 | None

receipt: JsonReceiptMessagev0 | None

typing: JsonTypingMessagev0 | None

class aiosignald.generated.JsonAccountv0

deviceId: int | None

username: str | None

filename: str | None

uuid: str | None

registered: bool | None

has_keys: bool | None

subscribed: bool | None

class aiosignald.generated.JsonAddressv0

number: str | None

uuid: str | None

relay: str | None

class aiosignald.generated.JsonDataMessagev0

timestamp: int | None

attachments: list[JsonAttachmentv0]

body: str | None

group: JsonGroupInfov0 | None

groupV2: JsonGroupV2Infov0 | None

endSession: bool | None

expiresInSeconds: int | None

profileKeyUpdate: bool | None

quote: JsonQuotev0 | None

contacts: list[SharedContactv0]

previews: list[JsonPreviewv0]

sticker: JsonStickerv0 | None

viewOnce: bool | None

reaction: JsonReactionv0 | None

remoteDelete: RemoteDeletev0 | None

mentions: list[JsonMentionv0]

class aiosignald.generated.JsonSyncMessagev0

sent: JsonSentTranscriptMessagev0 | None

contacts: JsonAttachmentv0 | None

contactsComplete: bool | None

groups: JsonAttachmentv0 | None

blockedList: JsonBlockedListMessagev0 | None

request: str | None

readMessages: list[JsonReadMessagev0]

viewOnceOpen: JsonViewOnceOpenMessagev0 | None

verified: JsonVerifiedMessagev0 | None

configuration: ConfigurationMessagev0 | None

stickerPackOperations: list[JsonStickerPackOperationMessagev0]

fetchType: str | None

messageRequestResponse: JsonMessageRequestResponseMessagev0 | None

class aiosignald.generated.JsonCallMessagev0

offerMessage: OfferMessagev0 | None

answerMessage: AnswerMessagev0 | None

busyMessage: BusyMessagev0 | None

hangupMessage: HangupMessagev0 | None

iceUpdateMessages: list[IceUpdateMessagev0]

destinationDeviceId: int | None

isMultiRing: bool | None

class aiosignald.generated.JsonReceiptMessagev0

type: str | None

timestamps: list[int]

when: int | None

class aiosignald.generated.JsonTypingMessagev0

action: str | None

timestamp: int | None

groupId: str | None

class aiosignald.generated.JsonAttachmentv0

contentType: str | None

id: str | None

size: int | None

storedFilename: str | None

filename: str | None

customFilename: str | None

caption: str | None

width: int | None

height: int | None

voiceNote: bool | None

key: str | None

digest: str | None

blurhash: str | None

class aiosignald.generated.JsonGroupInfov0

groupId: str | None

members: list[JsonAddressv0]

name: str | None

type: str | None

avatarId: int | None

class aiosignald.generated.JsonGroupV2Infov0

id: str | None

revision: int | None

title: str | None

description: str | None

avatar: str | None

timer: int | None

members: list[JsonAddressv0]

pendingMembers: list[JsonAddressv0]

requestingMembers: list[JsonAddressv0]

inviteLink: str | None

accessControl: GroupAccessControlv0 | None

memberDetail: list[GroupMemberv0]

pendingMemberDetail: list[GroupMemberv0]

class aiosignald.generated.JsonQuotev0

A quote is a reply to a previous message. ID is the sent time of the message being replied to

id: int | None

author: JsonAddressv0 | None

text: str | None

attachments: list[JsonQuotedAttachmentv0]

mentions: list[JsonMentionv0]

class aiosignald.generated.SharedContactv0

name: Namev0 | None

avatar: Optionalv0 | None

phone: Optionalv0 | None

email: Optionalv0 | None

address: Optionalv0 | None

organization: Optionalv0 | None

class aiosignald.generated.JsonPreviewv0

url: str | None

title: str | None

attachment: JsonAttachmentv0 | None

class aiosignald.generated.JsonStickerv0

packID: str | None

packKey: str | None

stickerID: int | None

attachment: JsonAttachmentv0 | None

image: str | None

class aiosignald.generated.JsonReactionv0

emoji: str | None

remove: bool | None

targetAuthor: JsonAddressv0 | None

targetSentTimestamp: int | None

class aiosignald.generated.RemoteDeletev0

targetSentTimestamp: int | None

class aiosignald.generated.JsonMentionv0

uuid: str | None

start: int | None

length: int | None

class aiosignald.generated.JsonSentTranscriptMessagev0

destination: JsonAddressv0 | None

timestamp: int | None

expirationStartTimestamp: int | None

message: JsonDataMessagev0 | None

unidentifiedStatus: dict | None

isRecipientUpdate: bool | None

class aiosignald.generated.JsonBlockedListMessagev0

addresses: list[JsonAddressv0]

groupIds: list[str]

class aiosignald.generated.JsonReadMessagev0

sender: JsonAddressv0 | None

timestamp: int | None

class aiosignald.generated.JsonViewOnceOpenMessagev0

sender: JsonAddressv0 | None

timestamp: int | None

class aiosignald.generated.JsonVerifiedMessagev0

destination: JsonAddressv0 | None

identityKey: str | None

verified: str | None

timestamp: int | None

class aiosignald.generated.ConfigurationMessagev0

readReceipts: Optionalv0 | None

unidentifiedDeliveryIndicators: Optionalv0 | None

typingIndicators: Optionalv0 | None

linkPreviews: Optionalv0 | None

class aiosignald.generated.JsonStickerPackOperationMessagev0

packID: str | None

packKey: str | None

type: str | None

class aiosignald.generated.OfferMessagev0

id: int | None

sdp: str | None

type: Typev0 | None

opaque: str | None

class aiosignald.generated.AnswerMessagev0

id: int | None

sdp: str | None

opaque: str | None

class aiosignald.generated.BusyMessagev0

id: int | None

class aiosignald.generated.HangupMessagev0

id: int | None

type: Typev0 | None

deviceId: int | None

legacy: bool | None

class aiosignald.generated.IceUpdateMessagev0

id: int | None

opaque: str | None

sdp: str | None

class aiosignald.generated.JsonQuotedAttachmentv0

contentType: str | None

fileName: str | None

thumbnail: JsonAttachmentv0 | None

class aiosignald.generated.GroupAccessControlv0

group access control settings. Options for each controlled action are: UNKNOWN, ANY, MEMBER, ADMINISTRATOR, UNSATISFIABLE and UNRECOGNIZED

link: str | None

attributes: str | None

members: str | None

class aiosignald.generated.GroupMemberv0

uuid: str | None

role: str | None

joined_revision: int | None

class aiosignald.generated.Namev0

display: Optionalv0 | None

given: Optionalv0 | None

family: Optionalv0 | None

prefix: Optionalv0 | None

suffix: Optionalv0 | None

middle: Optionalv0 | None

class aiosignald.generated.Optionalv0

empty: bool | None

present: bool | None

class aiosignald.generated.Typev0

class aiosignald.generated.ClientMessageWrapperv1

Wraps all incoming messages sent to the client after a v1 subscribe request is issued

type: str | None

version: str | None

data: dict | None

error: bool | None

account: str | None

class aiosignald.generated.IncomingMessagev1

account: str | None

source: JsonAddressv1 | None

type: str | None

timestamp: int | None

source_device: int | None

server_receiver_timestamp: int | None

server_deliver_timestamp: int | None

has_legacy_message: bool | None

has_content: bool | None

unidentified_sender: bool | None

data_message: JsonDataMessagev1 | None

sync_message: JsonSyncMessagev1 | None

call_message: CallMessagev1 | None

receipt_message: ReceiptMessagev1 | None

typing_message: TypingMessagev1 | None

story_message: StoryMessagev1 | None

server_guid: str | None

decryption_error_message: DecryptionErrorMessagev1 | None

class aiosignald.generated.ListenerStatev1

prior attempt to indicate signald connectivity state. WebSocketConnectionState messages will be delivered at the same time as well as in other parts of the websocket lifecycle.

connected: bool | None

class aiosignald.generated.WebSocketConnectionStatev1

indicates when the websocket connection state to the signal server has changed

state: str | None

socket: str | None

class aiosignald.generated.StorageChangev1

Broadcast to subscribed clients when there is a state change from the storage service

version: int | None

class aiosignald.generated.SendResponsev1

results: list[JsonSendMessageResultv1]

timestamp: int | None

class aiosignald.generated.JsonVersionMessagev1

name: str | None

version: str | None

branch: str | None

commit: str | None

class aiosignald.generated.JsonGroupV2Infov1

Information about a Signal group

id: str | None

revision: int | None

title: str | None

description: str | None

avatar: str | None

timer: int | None

members: list[JsonAddressv1]

pendingMembers: list[JsonAddressv1]

requestingMembers: list[JsonAddressv1]

inviteLink: str | None

accessControl: GroupAccessControlv1 | None

memberDetail: list[GroupMemberv1]

pendingMemberDetail: list[GroupMemberv1]

announcements: str | None

removed: bool | None

banned_members: list[BannedGroupMemberv1]

group_change: GroupChangev1 | None

class aiosignald.generated.LinkedDevicesv1

devices: list[DeviceInfov1]

class aiosignald.generated.JsonGroupJoinInfov1

groupID: str | None

title: str | None

description: str | None

memberCount: int | None

addFromInviteLink: int | None

revision: int | None

pendingAdminApproval: bool | None

class aiosignald.generated.GroupInfov1

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

v1: JsonGroupInfov1 | None

v2: JsonGroupV2Infov1 | None

class aiosignald.generated.SetProfilev1

account: str | None

name: str | None

avatarFile: str | None

about: str | None

emoji: str | None

mobilecoin_address: str | None

visible_badge_ids: list[str]

class aiosignald.generated.JsonAddressv1

number: str | None

uuid: str | None

relay: str | None

class aiosignald.generated.Profilev1

Information about a Signal user

name: str | None

avatar: str | None

address: JsonAddressv1 | None

capabilities: Capabilitiesv1 | None

color: str | None

about: str | None

emoji: str | None

contact_name: str | None

profile_name: str | None

inbox_position: int | None

expiration_time: int | None

mobilecoin_address: str | None

visible_badge_ids: list[str]

class aiosignald.generated.GroupListv1

groups: list[JsonGroupV2Infov1]

legacyGroups: list[JsonGroupInfov1]

class aiosignald.generated.ProfileListv1

profiles: list[Profilev1]

class aiosignald.generated.LinkingURIv1

uri: str | None

session_id: str | None

class aiosignald.generated.Accountv1

A local account in signald

address: JsonAddressv1 | None

pending: bool | None

pni: str | None

device_id: int | None

account_id: str | None

class aiosignald.generated.IdentityKeyListv1

a list of identity keys associated with a particular address

address: JsonAddressv1 | None

identities: list[IdentityKeyv1]

class aiosignald.generated.AccountListv1

accounts: list[Accountv1]

class aiosignald.generated.GetAllIdentitiesv1

get all known identity keys

account: str | None

class aiosignald.generated.AllIdentityKeyListv1

identity_keys: list[IdentityKeyListv1]

class aiosignald.generated.ServerListv1

servers: list[Serverv1]

class aiosignald.generated.RemoteConfigListv1

config: list[RemoteConfigv1]

class aiosignald.generated.BooleanMessagev1

A message containing a single boolean, usually as a response

value: bool | None

class aiosignald.generated.GroupHistoryPagev1

The result of fetching a group’s history along with paging data.

results: list[GroupHistoryEntryv1]

paging_data: PagingDatav1 | None

class aiosignald.generated.JsonSendMessageResultv1

address: JsonAddressv1 | None

success: SendSuccessv1 | None

networkFailure: bool | None

unregisteredFailure: bool | None

identityFailure: str | None

proof_required_failure: aiosignald.exc.ProofRequiredError | None

class aiosignald.generated.IdentityKeyv1

added: int | None

safety_number: str | None

qr_code_data: str | None

trust_level: str | None

class aiosignald.generated.JsonDataMessagev1

timestamp: int | None

attachments: list[JsonAttachmentv1]

body: str | None

group: JsonGroupInfov1 | None

groupV2: JsonGroupV2Infov1 | None

endSession: bool | None

expiresInSeconds: int | None

profileKeyUpdate: bool | None

quote: JsonQuotev1 | None

contacts: list[SharedContactv1]

previews: list[JsonPreviewv1]

sticker: JsonStickerv0 | None

viewOnce: bool | None

reaction: JsonReactionv1 | None

remoteDelete: RemoteDeletev1 | None

mentions: list[JsonMentionv1]

payment: Paymentv1 | None

is_expiration_update: bool | None

group_call_update: str | None

story_context: StoryContextv1 | None

class aiosignald.generated.JsonSyncMessagev1

sent: JsonSentTranscriptMessagev1 | None

contacts: JsonAttachmentv1 | None

contactsComplete: bool | None

groups: JsonAttachmentv1 | None

blockedList: JsonBlockedListMessagev1 | None

request: str | None

readMessages: list[JsonReadMessagev1]

viewOnceOpen: JsonViewOnceOpenMessagev1 | None

verified: JsonVerifiedMessagev1 | None

configuration: ConfigurationMessagev0 | None

stickerPackOperations: list[JsonStickerPackOperationMessagev0]

fetchType: str | None

messageRequestResponse: JsonMessageRequestResponseMessagev1 | None

class aiosignald.generated.CallMessagev1

offer_message: OfferMessagev1 | None

answer_message: AnswerMessagev1 | None

busy_message: BusyMessagev1 | None

hangup_message: HangupMessagev1 | None

ice_update_message: list[IceUpdateMessagev1]

destination_device_id: int | None

multi_ring: bool | None

class aiosignald.generated.ReceiptMessagev1

type: str | None

timestamps: list[int]

when: int | None

class aiosignald.generated.TypingMessagev1

action: str | None

timestamp: int | None

group_id: str | None

class aiosignald.generated.StoryMessagev1

group: JsonGroupV2Infov1 | None

file: JsonAttachmentv1 | None

text: TextAttachmentv1 | None

allow_replies: bool | None

class aiosignald.generated.DecryptionErrorMessagev1

timestamp: int | None

device_id: int | None

ratchet_key: str | None

class aiosignald.generated.JsonAttachmentv1

represents a file attached to a message. When sending, only filename is required.

contentType: str | None

id: str | None

size: int | None

storedFilename: str | None

filename: str | None

customFilename: str | None

caption: str | None

width: int | None

height: int | None

voiceNote: bool | None

key: str | None

digest: str | None

blurhash: str | None

class aiosignald.generated.JsonQuotev1

A quote is a reply to a previous message. ID is the sent time of the message being replied to

id: int | None

author: JsonAddressv1 | None

text: str | None

attachments: list[JsonQuotedAttachmentv0]

mentions: list[JsonMentionv1]

class aiosignald.generated.JsonMentionv1

uuid: str | None

start: int | None

length: int | None

class aiosignald.generated.JsonPreviewv1

metadata about one of the links in a message

url: str | None

title: str | None

description: str | None

date: int | None

attachment: JsonAttachmentv1 | None

class aiosignald.generated.JsonReactionv1

emoji: str | None

remove: bool | None

targetAuthor: JsonAddressv1 | None

targetSentTimestamp: int | None

class aiosignald.generated.GroupAccessControlv1

group access control settings. Options for each controlled action are: UNKNOWN, ANY, MEMBER, ADMINISTRATOR, UNSATISFIABLE and UNRECOGNIZED

link: str | None

attributes: str | None

members: str | None

class aiosignald.generated.GroupMemberv1

uuid: str | None

role: str | None

joined_revision: int | None

class aiosignald.generated.BannedGroupMemberv1

uuid: str | None

timestamp: int | None

class aiosignald.generated.GroupChangev1

Represents a group change made by a user. This can also represent request link invites. Only the fields relevant to the group change performed will be set. Note that in signald, group changes are currently only received from incoming messages from a message subscription.

editor: JsonAddressv1 | None

revision: int | None

new_members: list[GroupMemberv1]

delete_members: list[JsonAddressv1]

modify_member_roles: list[GroupMemberv1]

modified_profile_keys: list[GroupMemberv1]

new_pending_members: list[GroupPendingMemberv1]

delete_pending_members: list[JsonAddressv1]

promote_pending_members: list[GroupMemberv1]

new_banned_members: list[BannedGroupMemberv1]

new_unbanned_members: list[BannedGroupMemberv1]

new_title: str | None

new_avatar: bool | None

new_timer: int | None

new_access_control: GroupAccessControlv1 | None

new_requesting_members: list[GroupRequestingMemberv1]

delete_requesting_members: list[JsonAddressv1]

promote_requesting_members: list[GroupMemberv1]

new_invite_link_password: bool | None

new_description: str | None

new_is_announcement_group: str | None

class aiosignald.generated.DeviceInfov1

id: int | None

name: str | None

created: int | None

lastSeen: int | None

class aiosignald.generated.JsonGroupInfov1

information about a legacy group

groupId: str | None

members: list[JsonAddressv1]

name: str | None

type: str | None

avatarId: int | None

class aiosignald.generated.Capabilitiesv1

gv2: bool | None

storage: bool | None

stories: bool | None

gv1_migration: bool | None

sender_key: bool | None

announcement_group: bool | None

change_number: bool | None

class aiosignald.generated.Serverv1

a Signal server

uuid: str | None

proxy: str | None

ca: str | None

service_url: str | None

cdn_urls: list[ServerCDNv1]

contact_discovery_url: str | None

key_backup_url: str | None

storage_url: str | None

zk_param: str | None

unidentified_sender_root: str | None

key_backup_service_name: str | None

key_backup_service_id: str | None

key_backup_mrenclave: str | None

cds_mrenclave: str | None

ias_ca: str | None

class aiosignald.generated.Paymentv1

details about a MobileCoin payment

receipt: str | None

note: str | None

class aiosignald.generated.RemoteConfigv1

A remote config (feature flag) entry.

name: str | None

value: str | None

class aiosignald.generated.GroupHistoryEntryv1

group: JsonGroupV2Infov1 | None

change: GroupChangev1 | None

class aiosignald.generated.PagingDatav1

has_more_pages: bool | None

next_page_revision: int | None

class aiosignald.generated.JsonViewOnceOpenMessagev1

sender: JsonAddressv1 | None

timestamp: int | None

class aiosignald.generated.SendSuccessv1

unidentified: bool | None

needsSync: bool | None

duration: int | None

devices: list[int]

class aiosignald.generated.SharedContactv1

name: SharedContactNamev1 | None

email: list[SharedContactEmailv1]

phone: list[SharedContactPhonev1]

address: list[SharedContactAddressv1]

avatar: SharedContactAvatarv1 | None

organization: str | None

class aiosignald.generated.RemoteDeletev1

target_sent_timestamp: int | None

class aiosignald.generated.StoryContextv1

author: str | None

sent_timestamp: int | None

class aiosignald.generated.JsonSentTranscriptMessagev1

destination: JsonAddressv1 | None

timestamp: int | None

expirationStartTimestamp: int | None

message: JsonDataMessagev1 | None

story: StoryMessagev1 | None

unidentifiedStatus: dict | None

isRecipientUpdate: bool | None

class aiosignald.generated.JsonBlockedListMessagev1

addresses: list[JsonAddressv1]

groupIds: list[str]

class aiosignald.generated.JsonReadMessagev1

sender: JsonAddressv1 | None

timestamp: int | None

class aiosignald.generated.JsonVerifiedMessagev1

destination: JsonAddressv1 | None

identityKey: str | None

verified: str | None

timestamp: int | None

class aiosignald.generated.OfferMessagev1

id: int | None

sdp: str | None

type: str | None

opaque: str | None

class aiosignald.generated.AnswerMessagev1

id: int | None

sdp: str | None

opaque: str | None

class aiosignald.generated.BusyMessagev1

id: int | None

class aiosignald.generated.HangupMessagev1

id: int | None

type: str | None

legacy: bool | None

device_id: int | None

class aiosignald.generated.IceUpdateMessagev1

id: int | None

opaque: str | None

sdp: str | None

class aiosignald.generated.TextAttachmentv1

text: str | None

style: str | None

preview: JsonPreviewv1 | None

text_foreground_color: str | None

text_background_color: str | None

background_gradient: Gradientv1 | None

background_color: str | None

class aiosignald.generated.GroupPendingMemberv1

uuid: str | None

role: str | None

timestamp: int | None

added_by_uuid: str | None

class aiosignald.generated.ServerCDNv1

number: int | None

url: str | None

class aiosignald.generated.SharedContactNamev1

display: str | None

given: str | None

middle: str | None

family: str | None

prefix: str | None

suffix: str | None

class aiosignald.generated.SharedContactEmailv1

type: str | None

value: str | None

label: str | None

class aiosignald.generated.SharedContactPhonev1

type: str | None

value: str | None

label: str | None

class aiosignald.generated.SharedContactAddressv1

type: str | None

label: str | None

street: str | None

pobox: str | None

neighborhood: str | None

city: str | None

region: str | None

postcode: str | None

country: str | None

class aiosignald.generated.SharedContactAvatarv1

attachment: JsonAttachmentv1 | None

is_profile: bool | None

class aiosignald.generated.Gradientv1

colors: list[str]

angle: int | None

positions: list[float]

start_color: str | None

end_color: str | None

class aiosignald.generated.SignaldGeneratedAPI(on_con_lost: asyncio.Future | None = None)

Bases: aiosignald.util.JSONProtocol

Interface for stream protocol.

The user should implement this interface. They can inherit from this class but don’t need to. The implementations here do nothing (they don’t raise exceptions).

When the user wants to requests a transport, they pass a protocol factory to a utility function (e.g., EventLoop.create_connection()).

When the connection is made successfully, connection_made() is called with a suitable transport object. Then data_received() will be called 0 or more times with data (bytes) received from the transport; finally, connection_lost() will be called exactly once with either an exception object or None as an argument.

State machine of calls:

start -> CM [-> DR*] [-> ER?] -> CL -> end

CM: connection_made()
DR: data_received()
ER: eof_received()
CL: connection_lost()

Parameters:

username – Example: “+12024561414”
account – Example: “0cc10e61-d64c-4dbc-b51c-334f7dd45a4a”
recipientAddress –
recipientGroupId – Example: “EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=”
messageBody – Example: “hello”
attachments –
quote –
timestamp –
mentions –
previews –
members – Optionally set to a sub-set of group members. Ignored if recipientGroupId isn’t specified
is_for_story – set to true when replying to a story

react to a previous message

Parameters:

username – Example: “+12024561414”
recipientAddress –
recipientGroupId – Example: “EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=”
reaction –
timestamp –
members – Optionally set to a sub-set of group members. Ignored if recipientGroupId isn’t specified

async version() → JsonVersionMessagev1

async accept_invitation(account: str | None = None, groupID: str | None = None) → JsonGroupV2Infov1

Accept a v2 group invitation. Note that you must have a profile name set to join groups.

Parameters:

account – The account to interact with Example: “0cc10e61-d64c-4dbc-b51c-334f7dd45a4a”
groupID – Example: “EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=”

async approve_membership(account: str | None = None, groupID: str | None = None, members: list[JsonAddressv1] | None = None) → JsonGroupV2Infov1

approve a request to join a group

Parameters:

account – The account to interact with Example: “0cc10e61-d64c-4dbc-b51c-334f7dd45a4a”
groupID – Example: “EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=”
members – list of requesting members to approve

async get_group(account: str | None = None, groupID: str | None = None, revision: int | None = None) → JsonGroupV2Infov1

Query the server for the latest state of a known group. If the account is not a member of the group, an UnknownGroupError is returned.

Parameters:

account – The account to interact with Example: “0cc10e61-d64c-4dbc-b51c-334f7dd45a4a”
groupID – Example: “EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=”
revision – the latest known revision, default value (-1) forces fetch from server

async get_linked_devices(account: str | None = None) → LinkedDevicesv1

list all linked devices on a Signal account

Parameters:: account – The account to interact with Example: “0cc10e61-d64c-4dbc-b51c-334f7dd45a4a”

async join_group(account: str | None = None, uri: str | None = None) → JsonGroupJoinInfov1

Join a group using the a signal.group URL. Note that you must have a profile name set to join groups.

Parameters:

account – The account to interact with Example: “0cc10e61-d64c-4dbc-b51c-334f7dd45a4a”
uri – The signal.group URL Example: “https://signal.group/#CjQKINH_GZhXhfifTcnBkaKTNRxW-hHKnGSq-cJNyPVqHRp8EhDUB7zjKNEl0NaULhsqJCX3”

async remove_linked_device(account: str | None = None, deviceId: int | None = None)

Remove a linked device from the Signal account. Only allowed when the local device id is 1

Parameters:

account – The account to interact with Example: “+12024561414”
deviceId – the ID of the device to unlink Example: 3

modify a group. Note that only one modification action may be performed at once

Parameters:

account – The identifier of the account to interact with Example: “0cc10e61-d64c-4dbc-b51c-334f7dd45a4a”
groupID – the ID of the group to update Example: “EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=”
title – Example: “Parkdale Run Club”
description – A new group description. Set to empty string to remove an existing description. Example: “A club for running in Parkdale”
avatar – Example: “/tmp/image.jpg”
updateTimer – update the group timer.
addMembers –
removeMembers –
updateRole –
updateAccessControl – note that only one of the access controls may be updated per request
resetLink – regenerate the group link password, invalidating the old one
announcements – ENABLED to only allow admins to post messages, DISABLED to allow anyone to post

Parameters:

account – The phone number of the account to use Example: “+12024561414”
name – Change the profile name Example: “signald user”
avatarFile – Path to new profile avatar file. If unset or null, unset the profile avatar Example: “/tmp/image.jpg”
about – Change the ‘about’ profile field
emoji – Change the profile emoji
mobilecoin_address – Change the profile payment address. Payment address must be a base64-encoded MobileCoin address. Note that this is not the traditional MobileCoin address encoding, which is custom. Clients are responsible for converting between MobileCoin’s custom base58 on the user-facing side and base64 encoding on the signald side.
visible_badge_ids – configure visible badge IDs

async resolve_address(account: str | None = None, partial: JsonAddressv1 | None = None) → JsonAddressv1

Resolve a partial JsonAddress with only a number or UUID to one with both. Anywhere that signald accepts a JsonAddress will except a partial, this is a convenience function for client authors, mostly because signald doesn’t resolve all the partials it returns.

Parameters:

account – The signal account to use Example: “0cc10e61-d64c-4dbc-b51c-334f7dd45a4a”
partial – The partial address, missing fields

async mark_read(account: str | None = None, to: JsonAddressv1 | None = None, timestamps: list[int] | None = None, when: int | None = None)

Parameters:

account – The account to interact with Example: “0cc10e61-d64c-4dbc-b51c-334f7dd45a4a”
to – The address that sent the message being marked as read
timestamps – List of messages to mark as read Example: 1615576442475
when –

async get_profile(account: str | None = None, async_: bool | None = None, address: JsonAddressv1 | None = None) → Profilev1

Get all information available about a user

Parameters:

account – the signald account to use Example: “0cc10e61-d64c-4dbc-b51c-334f7dd45a4a”
async – if true, return results from local store immediately, refreshing from server in the background if needed. if false (default), block until profile can be retrieved from server
address – the address to look up

async list_groups(account: str | None = None) → GroupListv1

Parameters:: account – Example: “0cc10e61-d64c-4dbc-b51c-334f7dd45a4a”

async list_contacts(account: str | None = None, async_: bool | None = None) → ProfileListv1

Parameters:

account – Example: “0cc10e61-d64c-4dbc-b51c-334f7dd45a4a”
async – return results from local store immediately, refreshing from server afterward if needed. If false (default), block until all pending profiles have been retrieved.

Parameters:

account – The account to interact with Example: “0cc10e61-d64c-4dbc-b51c-334f7dd45a4a”
title – Example: “Parkdale Run Club”
avatar – Example: “/tmp/image.jpg”
members –
timer – the message expiration timer
member_role – The role of all members other than the group creator. Options are ADMINISTRATOR or DEFAULT (case insensitive) Example: “ADMINISTRATOR”

async leave_group(account: str | None = None, groupID: str | None = None) → GroupInfov1

Parameters:

account – The account to use Example: “0cc10e61-d64c-4dbc-b51c-334f7dd45a4a”
groupID – The group to leave Example: “EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=”

async generate_linking_uri(server: str | None = None) → LinkingURIv1

Generate a linking URI. Typically this is QR encoded and scanned by the primary device. Submit the returned session_id with a finish_link request.

Parameters:: server – The identifier of the server to use. Leave blank for default (usually Signal production servers but configurable at build time)

async finish_link(overwrite: bool | None = None, device_name: str | None = None, session_id: str | None = None) → Accountv1

After a linking URI has been requested, finish_link must be called with the session_id provided with the URI. it will return information about the new account once the linking process is completed by the other device and the new account is setup. Note that the account setup process can sometimes take some time, if rapid userfeedback is required after scanning, use wait_for_scan first, then finish setup with finish_link.

Parameters:

overwrite – overwrite existing account data if the phone number conflicts. false by default
device_name –
session_id –

async add_device(account: str | None = None, uri: str | None = None)

Link a new device to a local Signal account

Parameters:

account – The account to interact with Example: “0cc10e61-d64c-4dbc-b51c-334f7dd45a4a”
uri – the sgnl://linkdevice uri provided (typically in qr code form) by the new device Example: “sgnl://linkdevice?uuid=jAaZ5lxLfh7zVw5WELd6-Q&pub_key=BfFbjSwmAgpVJBXUdfmSgf61eX3a%2Bq9AoxAVpl1HUap9”

async register(account: str | None = None, voice: bool | None = None, captcha: str | None = None, server: str | None = None) → Accountv1

begin the account registration process by requesting a phone number verification code. when the code is received, submit it with a verify request

Parameters:

account – the e164 phone number to register with Example: “+12024561414”
voice – set to true to request a voice call instead of an SMS for verification
captcha – See https://signald.org/articles/captcha/
server – The identifier of the server to use. Leave blank for default (usually Signal production servers but configurable at build time)

async verify(account: str | None = None, code: str | None = None) → Accountv1

verify an account’s phone number with a code after registering, completing the account creation process

Parameters:

account – the e164 phone number being verified Example: “+12024561414”
code – the verification code, dash (-) optional Example: “555555”

async get_identities(account: str | None = None, address: JsonAddressv1 | None = None) → IdentityKeyListv1

Get information about a known keys for a particular address

Parameters:

account – The account to interact with Example: “0cc10e61-d64c-4dbc-b51c-334f7dd45a4a”
address – address to get keys for

Trust another user’s safety number using either the QR code data or the safety number text

Parameters:

account – The account to interact with Example: “0cc10e61-d64c-4dbc-b51c-334f7dd45a4a”
address – The user to query identity keys for
safety_number – required if qr_code_data is absent Example: “373453558586758076680580548714989751943247272727416091564451”
qr_code_data – base64-encoded QR code data. required if safety_number is absent
trust_level – One of TRUSTED_UNVERIFIED, TRUSTED_VERIFIED or UNTRUSTED. Default is TRUSTED_VERIFIED Example: “TRUSTED_VERIFIED”

async delete_account(account: str | None = None, server: bool | None = None)

delete all account data signald has on disk, and optionally delete the account from the server as well. Note that this is not “unlink” and will delete the entire account, even from a linked device.

Parameters:

account – The account to delete Example: “0cc10e61-d64c-4dbc-b51c-334f7dd45a4a”
server – delete account information from the server as well (default false)

send a typing started or stopped message

Parameters:

account – The account to use Example: “0cc10e61-d64c-4dbc-b51c-334f7dd45a4a”
address –
group – Example: “EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=”
typing – Example: true
when –

async reset_session(account: str | None = None, address: JsonAddressv1 | None = None, timestamp: int | None = None) → SendResponsev1

reset a session with a particular user

Parameters:

account – The account to use Example: “0cc10e61-d64c-4dbc-b51c-334f7dd45a4a”
address – the user to reset session with
timestamp –

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

Parameters:

groups – request group sync (default true)
configuration – request configuration sync (default true)
contacts – request contact sync (default true)
blocked – request block list sync (default true)
keys – request storage service keys
account – The account to use Example: “0cc10e61-d64c-4dbc-b51c-334f7dd45a4a”

async list_accounts() → AccountListv1: return all local accounts

async group_link_info(account: str | None = None, uri: str | None = None) → JsonGroupJoinInfov1

Get information about a group from a signal.group link

Parameters:

account – The account to use Example: “0cc10e61-d64c-4dbc-b51c-334f7dd45a4a”
uri – the signald.group link Example: “https://signal.group/#CjQKINH_GZhXhfifTcnBkaKTNRxW-hHKnGSq-cJNyPVqHRp8EhDUB7zjKNEl0NaULhsqJCX3”

update information about a local contact

Parameters:

account – Example: “0cc10e61-d64c-4dbc-b51c-334f7dd45a4a”
address –
name –
color –
inbox_position –

async set_expiration(account: str | None = None, address: JsonAddressv1 | None = None, group: str | None = None, expiration: int | None = None) → SendResponsev1

Set the message expiration timer for a thread. Expiration must be specified in seconds, set to 0 to disable timer

Parameters:

account – The account to use Example: “0cc10e61-d64c-4dbc-b51c-334f7dd45a4a”
address –
group – Example: “EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=”
expiration – Example: 604800

async set_device_name(account: str | None = None, device_name: str | None = None)

set this device’s name. This will show up on the mobile device on the same account under settings -> linked devices

Parameters:

account – The account to set the device name of Example: “0cc10e61-d64c-4dbc-b51c-334f7dd45a4a”
device_name – The device name

async get_all_identities(account: str | None = None) → AllIdentityKeyListv1

get all known identity keys

Parameters:: account – The account to interact with Example: “+12024561414”

async subscribe(account: str | None = None)

receive incoming messages. After making a subscribe request, incoming messages will be sent to the client encoded as ClientMessageWrapper. Send an unsubscribe request or disconnect from the socket to stop receiving messages.

Parameters:: account – The account to subscribe to incoming message for Example: “0cc10e61-d64c-4dbc-b51c-334f7dd45a4a”

async unsubscribe(account: str | None = None)

See subscribe for more info

Parameters:: account – The account to unsubscribe from Example: “0cc10e61-d64c-4dbc-b51c-334f7dd45a4a”

delete a message previously sent

Parameters:

account – the account to use Example: “0cc10e61-d64c-4dbc-b51c-334f7dd45a4a”
address – the address to send the delete message to. should match address the message to be deleted was sent to. required if group is not set.
group – the group to send the delete message to. should match group the message to be deleted was sent to. required if address is not set. Example: “EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=”
timestamp –
members – Optionally set to a sub-set of group members. Ignored if group isn’t specified

async add_server(server: Serverv1 | None = None) → Stringv1

add a new server to connect to. Returns the new server’s UUID.

Parameters:: server –

async get_servers() → ServerListv1

async delete_server(uuid: str | None = None)

Parameters:: uuid –

async send_payment(account: str | None = None, address: JsonAddressv1 | None = None, payment: Paymentv1 | None = None, when: int | None = None) → SendResponsev1

send a mobilecoin payment

Parameters:

account – the account to use Example: “0cc10e61-d64c-4dbc-b51c-334f7dd45a4a”
address – the address to send the payment message to
payment –
when –

async get_remote_config(account: str | None = None) → RemoteConfigListv1

Retrieves the remote config (feature flags) from the server.

Parameters:: account – The account to use to retrieve the remote config Example: “0cc10e61-d64c-4dbc-b51c-334f7dd45a4a”

async refuse_membership(account: str | None = None, members: list[JsonAddressv1] | None = None, group_id: str | None = None, also_ban: bool | None = None) → JsonGroupV2Infov1

deny a request to join a group

Parameters:

account – The account to interact with Example: “0cc10e61-d64c-4dbc-b51c-334f7dd45a4a”
members – list of requesting members to refuse
group_id – Example: “EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=”
also_ban –

async submit_challenge(account: str | None = None, challenge: str | None = None, captcha_token: str | None = None)

Parameters:

account – Example: “0cc10e61-d64c-4dbc-b51c-334f7dd45a4a”
challenge –
captcha_token –

async is_identifier_registered(account: str | None = None, identifier: str | None = None) → BooleanMessagev1

Determine whether an account identifier is registered on the Signal service.

Parameters:

account – The account to use to use Example: “0cc10e61-d64c-4dbc-b51c-334f7dd45a4a”
identifier – The UUID of an identifier to check if it is registered on Signal. This UUID is either a Phone Number Identity (PNI) or an Account Identity (ACI). Example: “aeed01f0-a234-478e-8cf7-261c283151e7”

async wait_for_scan(session_id: str | None = None)

An optional part of the linking process. Intended to be called after displaying the QR code, will return quickly after the user scans the QR code. finish_link must be called after wait_for_scan returns a non-error

Parameters:: session_id –

async get_group_revision_pages(account: str | None = None, group_id: str | None = None, from_revision: int | None = None, include_first_revision: bool | None = None) → GroupHistoryPagev1

Query the server for group revision history. The history contains information about the changes between each revision and the user that made the change.

Parameters:

account – The account to interact with Example: “0cc10e61-d64c-4dbc-b51c-334f7dd45a4a”
group_id – Example: “EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=”
from_revision – The revision to start the pages from. Note that if this is lower than the revision you joined the group, an AuthorizationFailedError is returned.
include_first_revision – Whether to include the first state in the returned pages (default false)

async send_sync_message(account: str | None = None, view_once_open_message: JsonViewOnceOpenMessagev1 | None = None, message_request_response: JsonMessageRequestResponseMessagev1 | None = None) → JsonSendMessageResultv1

Sends a sync message to the account’s devices

Parameters:

account – Example: “0cc10e61-d64c-4dbc-b51c-334f7dd45a4a”
view_once_open_message – This can be set to indicate to other devices about having viewed a view-once message.
message_request_response – This can be set to indicate to other devices about a response to an incoming message request from an unknown user or group. Warning: Using the BLOCK and BLOCK_AND_DELETE options relies on other devices to do the blocking, and it does not make you leave the group!

async ban_user(account: str | None = None, group_id: str | None = None, users: list[JsonAddressv1] | None = None) → JsonGroupV2Infov1

Bans users from a group. This works even if the users aren’t in the group. If they are currently in the group, they will also be removed.

Parameters:

account – The account to interact with Example: “0cc10e61-d64c-4dbc-b51c-334f7dd45a4a”
group_id – Example: “EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=”
users – List of users to ban

async unban_user(account: str | None = None, group_id: str | None = None, users: list[JsonAddressv1] | None = None) → JsonGroupV2Infov1

Unbans users from a group.

Parameters:

account – The account to interact with Example: “0cc10e61-d64c-4dbc-b51c-334f7dd45a4a”
group_id – Example: “EdSqI90cS0UomDpgUXOlCoObWvQOXlH5G3Z2d3f4ayE=”
users – List of users to unban

aiosignald.generated

Module Contents

Classes

`aiosignald.generated`