slidgnal.generated.signal

Attributes

_collections_abc
cwd
currentdir
EventUnknown	The event types handled by the overarching session adapter handler.
EventLogin	The event types handled by the overarching session adapter handler.
EventArchiveSync	The event types handled by the overarching session adapter handler.
EventConnect	The event types handled by the overarching session adapter handler.
EventLogout	The event types handled by the overarching session adapter handler.
EventContact	The event types handled by the overarching session adapter handler.
EventMessage	The event types handled by the overarching session adapter handler.
EventTyping	The event types handled by the overarching session adapter handler.
EventReceipt	The event types handled by the overarching session adapter handler.
EventDelete	The event types handled by the overarching session adapter handler.
MessagePlain	The message types handled by the overarching session event handler.
MessageAttachment	The message types handled by the overarching session event handler.
MessageReaction	The message types handled by the overarching session event handler.
MessageEdit	The message types handled by the overarching session event handler.
ReceiptUnknown	The delivery receipts handled by the overarching session event handler.
ReceiptDelivered	The delivery receipts handled by the overarching session event handler.
ReceiptRead	The delivery receipts handled by the overarching session event handler.
TypingStateStopped	The distinct typing states handled by the overarching session event handler.
TypingStateStarted	The distinct typing states handled by the overarching session event handler.

Classes

Slice_signal_Attachment	GoClass is the base class for all GoPy wrapper classes
Slice_signal_Contact	GoClass is the base class for all GoPy wrapper classes
EventKind	EventKind represents all event types recognized by the Python session adapter, as emitted by the
MessageKind	MessageKind represents all concrete message types (plain-text messages, edit messages, reactions)
ReceiptKind	ReceiptKind represents the different types of delivery receipts possible in Signal.
TypingState	A TypingState represents different states of typing notificates for incoming and outgoing messages.
Message	A Message represents one of many kinds of bidirectional communication payloads, for example, a
Reaction	A Reaction is a quick, emoji response to an existing message. Signal generally allows only a
Receipt	A Receipt represents a notice of delivery or presentation for [Message] instances sent or
Session	A Session represents a connection to Signal under a given [Gateway]. In general, sessions are
Typing	Typing contains event data related to typing notifications.
ArchiveSync	ArchiveSync represents event data for initial synchronization of chat state during login.
EventPayload	EventPayload represents the collected payloads for all event types handled by the overarching
Login	Login represents event data for login events, typically carrying QR code information used for
Reply	A Reply represents a reference to a previous message being replied to, with partial data set.
Attachment	A Attachment represents any binary data provided alongside a [Message], for instance, an image
Avatar	A Avatar represents a small image set for a [Contact] or [Group].
LinkedDevice	A LinkedDevice represents a unique pairing session between the gateway and Signal. It is not
Connect	Connect represents event data for connection events, typically carrying connection errors and
Contact	A Contact represents any entity that be communicated with directly in Signal. This typically
Delete	Delete represents a message deletion event, for any type of message.
Gateway	GoClass is the base class for all GoPy wrapper classes
Logout	Logout represents event data for logout events, either expected (due to unlinking of a device) or

Functions

NewSession(g, d)	NewSession(object g, object d) object
NewGateway()	NewGateway() object

Module Contents

slidgnal.generated.signal._collections_abc

slidgnal.generated.signal.cwd

slidgnal.generated.signal.currentdir

class slidgnal.generated.signal.Slice_signal_Attachment(*args, **kwargs)

Bases: slidgnal.generated.go.GoClass

GoClass is the base class for all GoPy wrapper classes

handle=A Go-side object is always initialized with an explicit handle=arg otherwise parameter is a python list that we copy from

index = 0

__del__()

__str__()

__repr__()

__len__()

__getitem__(key)

__setitem__(idx, value)

__iadd__(value)

__iter__()

__next__()

append(value)

copy(src)

copy emulates the go copy function, copying elements into this list from source list, up to min of size of each list

class slidgnal.generated.signal.Slice_signal_Contact(*args, **kwargs)

Bases: slidgnal.generated.go.GoClass

GoClass is the base class for all GoPy wrapper classes

handle=A Go-side object is always initialized with an explicit handle=arg otherwise parameter is a python list that we copy from

index = 0

__del__()

__str__()

__repr__()

__len__()

__getitem__(key)

__setitem__(idx, value)

__iadd__(value)

__iter__()

__next__()

append(value)

copy(src)

copy emulates the go copy function, copying elements into this list from source list, up to min of size of each list

class slidgnal.generated.signal.EventKind(*args, **kwds)

Bases: enum.Enum

EventKind represents all event types recognized by the Python session adapter, as emitted by the Go session adapter.

EventUnknown = 0

The event types handled by the overarching session adapter handler.

EventLogin = 1

The event types handled by the overarching session adapter handler.

EventArchiveSync = 2

The event types handled by the overarching session adapter handler.

EventConnect = 3

The event types handled by the overarching session adapter handler.

EventLogout = 4

The event types handled by the overarching session adapter handler.

EventContact = 5

The event types handled by the overarching session adapter handler.

EventMessage = 6

The event types handled by the overarching session adapter handler.

EventTyping = 7

The event types handled by the overarching session adapter handler.

EventReceipt = 8

The event types handled by the overarching session adapter handler.

EventDelete = 9

The event types handled by the overarching session adapter handler.

slidgnal.generated.signal.EventUnknown = 0

The event types handled by the overarching session adapter handler.

slidgnal.generated.signal.EventLogin = 1

The event types handled by the overarching session adapter handler.

slidgnal.generated.signal.EventArchiveSync = 2

The event types handled by the overarching session adapter handler.

slidgnal.generated.signal.EventConnect = 3

The event types handled by the overarching session adapter handler.

slidgnal.generated.signal.EventLogout = 4

The event types handled by the overarching session adapter handler.

slidgnal.generated.signal.EventContact = 5

The event types handled by the overarching session adapter handler.

slidgnal.generated.signal.EventMessage = 6

The event types handled by the overarching session adapter handler.

slidgnal.generated.signal.EventTyping = 7

The event types handled by the overarching session adapter handler.

slidgnal.generated.signal.EventReceipt = 8

The event types handled by the overarching session adapter handler.

slidgnal.generated.signal.EventDelete = 9

The event types handled by the overarching session adapter handler.

class slidgnal.generated.signal.MessageKind(*args, **kwds)

Bases: enum.Enum

MessageKind represents all concrete message types (plain-text messages, edit messages, reactions) recognized by the Python session adapter.

MessagePlain = 0

The message types handled by the overarching session event handler.

MessageAttachment = 1

The message types handled by the overarching session event handler.

MessageReaction = 2

The message types handled by the overarching session event handler.

MessageEdit = 3

The message types handled by the overarching session event handler.

slidgnal.generated.signal.MessagePlain = 0

The message types handled by the overarching session event handler.

slidgnal.generated.signal.MessageAttachment = 1

The message types handled by the overarching session event handler.

slidgnal.generated.signal.MessageReaction = 2

The message types handled by the overarching session event handler.

slidgnal.generated.signal.MessageEdit = 3

The message types handled by the overarching session event handler.

class slidgnal.generated.signal.ReceiptKind(*args, **kwds)

Bases: enum.Enum

ReceiptKind represents the different types of delivery receipts possible in Signal.

ReceiptUnknown = 0

The delivery receipts handled by the overarching session event handler.

ReceiptDelivered = 1

The delivery receipts handled by the overarching session event handler.

ReceiptRead = 2

The delivery receipts handled by the overarching session event handler.

slidgnal.generated.signal.ReceiptUnknown = 0

The delivery receipts handled by the overarching session event handler.

slidgnal.generated.signal.ReceiptDelivered = 1

The delivery receipts handled by the overarching session event handler.

slidgnal.generated.signal.ReceiptRead = 2

The delivery receipts handled by the overarching session event handler.

class slidgnal.generated.signal.TypingState(*args, **kwds)

Bases: enum.Enum

A TypingState represents different states of typing notificates for incoming and outgoing messages.

TypingStateStopped = 0

The distinct typing states handled by the overarching session event handler.

TypingStateStarted = 1

The distinct typing states handled by the overarching session event handler.

slidgnal.generated.signal.TypingStateStopped = 0

The distinct typing states handled by the overarching session event handler.

slidgnal.generated.signal.TypingStateStarted = 1

The distinct typing states handled by the overarching session event handler.

class slidgnal.generated.signal.Message(*args, **kwargs)

Bases: slidgnal.generated.go.GoClass

A Message represents one of many kinds of bidirectional communication payloads, for example, a text message, a file (image, video) attachment, an emoji reaction, etc. Messages of different kinds are denoted as such, and re-use fields where the semantics overlap.

handle=A Go-side object is always initialized with an explicit handle=arg otherwise parameters can be unnamed in order of field names or named fields in which case a new Go object is constructed first

__del__()

__str__()

__repr__()

property Kind

property ID

property ChatID

property SenderID

property TargetID

property Body

property Timestamp

property IsCarbon

property Typing

property Reaction

property ReplyTo

property Attachments

class slidgnal.generated.signal.Reaction(*args, **kwargs)

Bases: slidgnal.generated.go.GoClass

A Reaction is a quick, emoji response to an existing message. Signal generally allows only a single reaction to messages, and has special rules around removal of reactions.

handle=A Go-side object is always initialized with an explicit handle=arg otherwise parameters can be unnamed in order of field names or named fields in which case a new Go object is constructed first

__del__()

__str__()

__repr__()

property Emoji

property Remove

class slidgnal.generated.signal.Receipt(*args, **kwargs)

Bases: slidgnal.generated.go.GoClass

A Receipt represents a notice of delivery or presentation for [Message] instances sent or received. Receipts can be delivered for many messages at once, but are generally all delivered under one specific state at a time.

handle=A Go-side object is always initialized with an explicit handle=arg otherwise parameters can be unnamed in order of field names or named fields in which case a new Go object is constructed first

__del__()

__str__()

__repr__()

property Kind

property SenderID

property MessageIDs

property IsCarbon

class slidgnal.generated.signal.Session(*args, **kwargs)

Bases: slidgnal.generated.go.GoClass

A Session represents a connection to Signal under a given [Gateway]. In general, sessions are inactive until [Session.Login] is called and out-of-band registration is completed, in which case our internal event handlers will attempt to propagate any incoming events. Calls to session functions, such as [Session.GetContacts], will return an error immediately if the session is not active and authenticated.

handle=A Go-side object is always initialized with an explicit handle=arg otherwise parameters can be unnamed in order of field names or named fields in which case a new Go object is constructed first

__del__()

__str__()

__repr__()

Login()

Login() str

Logout()

Logout() str

Logout disconnects and unlinks the current active [Session]. If there is no active session, this function returns a nil error.

Disconnect()

Disconnect() str

Disconnect stops any active connection to Signal without removing authentication credentials.

SendMessage(message)

SendMessage(object message) str, str

SendMessage processes the given [Message], and sends it to to Signal. Messages can contain a multitude of different fields denoting different semantics, see the [Message] type for more information.

SendTyping(typing)

SendTyping(object typing) str

SendTyping sends a typing notification from us to a given contact on Signal.

SendReceipt(receipt)

SendReceipt(object receipt) str

SendReceipt sends a read receipt for for a given set of messages to Signal.

SendDelete(delete)

SendDelete(object delete) str

SendDelete sends a “Delete for Everyone” message to Signal for a given message ID.

GetBackupContacts()

GetBackupContacts() []object, str

GetBackupContacts fetches any contacts stored in local backup, which is usually populated by archive transfer during initial connection. Contact information returned may be partial.

GetContact(id)

GetContact(str id) object, str

GetContact returns a concrete [Contact] representation for the account ID given. If no contact information could be found, an empty contact will be returned with no error.

SetEventHandler(h, goRun=False)

SetEventHandler(callable h)

SetEventHandler assigns the given handler function for propagating internal events into the Python gateway. Note that the event handler function is not entirely safe to use directly, and all calls should instead be sent to the [Gateway] via its internal call channel.

class slidgnal.generated.signal.Typing(*args, **kwargs)

Bases: slidgnal.generated.go.GoClass

Typing contains event data related to typing notifications.

handle=A Go-side object is always initialized with an explicit handle=arg otherwise parameters can be unnamed in order of field names or named fields in which case a new Go object is constructed first

__del__()

__str__()

__repr__()

property State

property SenderID

class slidgnal.generated.signal.ArchiveSync(*args, **kwargs)

Bases: slidgnal.generated.go.GoClass

ArchiveSync represents event data for initial synchronization of chat state during login.

handle=A Go-side object is always initialized with an explicit handle=arg otherwise parameters can be unnamed in order of field names or named fields in which case a new Go object is constructed first

__del__()

__str__()

__repr__()

property Error

class slidgnal.generated.signal.EventPayload(*args, **kwargs)

Bases: slidgnal.generated.go.GoClass

EventPayload represents the collected payloads for all event types handled by the overarching session adapter handler. Only specific fields will be populated in events emitted by internal handlers, see documentation for specific types for more information.

handle=A Go-side object is always initialized with an explicit handle=arg otherwise parameters can be unnamed in order of field names or named fields in which case a new Go object is constructed first

__del__()

__str__()

__repr__()

property Login

property Logout

property ArchiveSync

property Connect

property Contact

property Message

property Typing

property Receipt

property Delete

class slidgnal.generated.signal.Login(*args, **kwargs)

Bases: slidgnal.generated.go.GoClass

Login represents event data for login events, typically carrying QR code information used for out-of-band authentication.

handle=A Go-side object is always initialized with an explicit handle=arg otherwise parameters can be unnamed in order of field names or named fields in which case a new Go object is constructed first

__del__()

__str__()

__repr__()

property QRCode

property DeviceID

property Error

class slidgnal.generated.signal.Reply(*args, **kwargs)

Bases: slidgnal.generated.go.GoClass

A Reply represents a reference to a previous message being replied to, with partial data set.

handle=A Go-side object is always initialized with an explicit handle=arg otherwise parameters can be unnamed in order of field names or named fields in which case a new Go object is constructed first

__del__()

__str__()

__repr__()

property ID

property AuthorID

property Body

class slidgnal.generated.signal.Attachment(*args, **kwargs)

Bases: slidgnal.generated.go.GoClass

A Attachment represents any binary data provided alongside a [Message], for instance, an image or voice message.

handle=A Go-side object is always initialized with an explicit handle=arg otherwise parameters can be unnamed in order of field names or named fields in which case a new Go object is constructed first

__del__()

__str__()

__repr__()

property ContentType

property Filename

property Data

class slidgnal.generated.signal.Avatar(*args, **kwargs)

Bases: slidgnal.generated.go.GoClass

A Avatar represents a small image set for a [Contact] or [Group].

handle=A Go-side object is always initialized with an explicit handle=arg otherwise parameters can be unnamed in order of field names or named fields in which case a new Go object is constructed first

__del__()

__str__()

__repr__()

property Delete

property Data

class slidgnal.generated.signal.LinkedDevice(*args, **kwargs)

Bases: slidgnal.generated.go.GoClass

A LinkedDevice represents a unique pairing session between the gateway and Signal. It is not unique to the underlying “main” device (or user/phone number), as multiple linked devices may be paired with any main device.

handle=A Go-side object is always initialized with an explicit handle=arg otherwise parameters can be unnamed in order of field names or named fields in which case a new Go object is constructed first

__del__()

__str__()

__repr__()

property ID

ID is an opaque string identifying this [LinkedDevice] to a [Session]. Noted that this string is currently equivalent to a password, and needs to be protected accordingly.

property ArchiveSynced

Whether or not we’ve previously tried to sync this device from the main device’s archive.

class slidgnal.generated.signal.Connect(*args, **kwargs)

Bases: slidgnal.generated.go.GoClass

Connect represents event data for connection events, typically carrying connection errors and other metadata.

handle=A Go-side object is always initialized with an explicit handle=arg otherwise parameters can be unnamed in order of field names or named fields in which case a new Go object is constructed first

__del__()

__str__()

__repr__()

property AccountID

property PhoneNumber

property Error

class slidgnal.generated.signal.Contact(*args, **kwargs)

Bases: slidgnal.generated.go.GoClass

A Contact represents any entity that be communicated with directly in Signal. This typically represents people, but not a group-chat.

handle=A Go-side object is always initialized with an explicit handle=arg otherwise parameters can be unnamed in order of field names or named fields in which case a new Go object is constructed first

__del__()

__str__()

__repr__()

property ID

property PhoneNumber

property Name

property Avatar

class slidgnal.generated.signal.Delete(*args, **kwargs)

Bases: slidgnal.generated.go.GoClass

Delete represents a message deletion event, for any type of message.

handle=A Go-side object is always initialized with an explicit handle=arg otherwise parameters can be unnamed in order of field names or named fields in which case a new Go object is constructed first

__del__()

__str__()

__repr__()

property AuthorID

property ChatID

property MessageID

property IsCarbon

class slidgnal.generated.signal.Gateway(*args, **kwargs)

Bases: slidgnal.generated.go.GoClass

GoClass is the base class for all GoPy wrapper classes

handle=A Go-side object is always initialized with an explicit handle=arg otherwise parameters can be unnamed in order of field names or named fields in which case a new Go object is constructed first

__del__()

__str__()

__repr__()

property DBPath

Common configuration.

property Name

property LogLevel

Init()

Init() str

class slidgnal.generated.signal.Logout(*args, **kwargs)

Bases: slidgnal.generated.go.GoClass

Logout represents event data for logout events, either expected (due to unlinking of a device) or unexpected (due to upstream errors).

handle=A Go-side object is always initialized with an explicit handle=arg otherwise parameters can be unnamed in order of field names or named fields in which case a new Go object is constructed first

__del__()

__str__()

__repr__()

property Reason

slidgnal.generated.signal.NewSession(g, d)

NewSession(object g, object d) object

NewSession returns a new, inactive connection to Signal. Sessions are expected to be activated via subsequent calls to [Session.Login], which will generally continue out-of-band; see the relevant documentation for more details.

slidgnal.generated.signal.NewGateway()

NewGateway() object