Versions in this module Expand all Collapse all v1 v1.0.0 Aug 13, 2026 Changes in this version + var ErrNotFound = errors.New("key not found") + func Bool(v bool) *bool + func Int(v int) *int + func Int64(v int64) *int64 + func String(v string) *string + type API struct + PhoneNumber string + SignalService string + func NewAPI(config *Config) *API + func (api *API) DeleteAttachment(attachmentId string) error + func (api *API) GetAttachment(attachmentId string) ([]byte, error) + func (api *API) GetGroup(groupId string) (GroupResponse, error) + func (api *API) GetGroups() ([]GroupResponse, error) + func (api *API) HealthCheck() error + func (api *API) React(receiver, emoji, targetAuthor string, targetTimestamp int64) error + func (api *API) ReceiveMessages(ctx context.Context) (<-chan Message, error) + func (api *API) RemoteDelete(receiver string, timestamp int64) error + func (api *API) SendMessage(receiver, text string, opts *SendOptions) (Message, error) + func (api *API) SendReceipt(receiver, receiptType string, timestamp int64) error + func (api *API) StartTyping(receiver string) error + func (api *API) StopTyping(receiver string) error + func (api *API) UpdateContact(recipient, name, expirationInSeconds string) error + type Authentication interface + ApplyTo func(headers map[string]string) + AuthString func() string + type BasicAuthentication struct + Password string + Username string + func (auth *BasicAuthentication) ApplyTo(headers map[string]string) + func (auth *BasicAuthentication) AuthString() string + type BearerAuthentication struct + Token string + func (auth *BearerAuthentication) ApplyTo(headers map[string]string) + func (auth *BearerAuthentication) AuthString() string + type Bot struct + API *API + Commands []Command + DownloadAttachments bool + PhoneNumber string + SignalService string + Storage Storage + func NewBot(config *Config) *Bot + func (b *Bot) MarkRead(receiver string, timestamp int64) error + func (b *Bot) React(receiver, emoji, targetAuthor string, targetTimestamp int64) error + func (b *Bot) Register(cmd Command) + func (b *Bot) Send(receiver, text string, opts *SendOptions) (Message, error) + func (b *Bot) Start() error + func (b *Bot) StartTyping(receiver string) error + func (b *Bot) StopTyping(receiver string) error + type Command interface + Handle func(ctx *Context) error + func ReactionTriggered(cmd Command, emojis ...string) Command + func RegexTriggered(cmd Command, patterns ...*regexp.Regexp) Command + func Triggered(cmd Command, caseSensitive bool, exactMatches ...string) Command + type CommandFunc func(ctx *Context) error + func (f CommandFunc) Handle(ctx *Context) error + type Config struct + Auth Authentication + DownloadAttachments bool + PhoneNumber string + SignalService string + Storage Storage + func NewConfig(signalService, phoneNumber string) *Config + type Context struct + Bot *Bot + Message Message + Storage Storage + func NewContext(bot *Bot, msg Message) *Context + func (c *Context) MarkRead() error + func (c *Context) React(emoji string) error + func (c *Context) Reply(text string) error + func (c *Context) Send(text string, opts *SendOptions) error + func (c *Context) StartTyping() error + func (c *Context) StopTyping() error + type GroupResponse struct + Description string + ID string + Members []string + Name string + type LinkPreview struct + Description string + Image string + Title string + URL string + type LinkPreviewRequest struct + Description string + Image string + Title string + URL string + type Message struct + AttachmentsLocalFilenames []string + Base64Attachments []string + Group *string + LinkPreviews []LinkPreview + Mentions []string + Quote *Quote + RawMessage string + Reaction *Reaction + ReadMessages []json.RawMessage + RemoteDeleteTimestamp *int64 + Source string + SourceNumber *string + SourceUUID string + TargetSentTimestamp *int64 + Text string + Timestamp int64 + Type MessageType + UpdatedGroupID *string + ViewOnce bool + func UnmarshalSignalJSON(payload []byte) (*Message, error) + func (m *Message) IsGroup() bool + func (m *Message) IsPrivate() bool + func (m *Message) Recipient() string + type MessageType int + const ContactSyncMessage + const DataMessage + const DeleteMessage + const EditMessage + const GroupUpdateMessage + const ReactionMessage + const ReadMessage + const SyncMessage + type Quote struct + Author string + Text string + Timestamp int64 + type Reaction struct + Emoji string + IsRemove bool + TargetAuthor string + TargetSentTimestamp int64 + type ReactionRequest struct + Reaction string + Recipient string + TargetAuthor string + Timestamp int64 + type ReceiptRequest struct + ReceiptType string + Recipient string + Timestamp int64 + type RedisStorage struct + func NewRedisStorage(host string, port int, password string) *RedisStorage + func (s *RedisStorage) Delete(ctx context.Context, key string) error + func (s *RedisStorage) Exists(ctx context.Context, key string) (bool, error) + func (s *RedisStorage) Read(ctx context.Context, key string, v any) error + func (s *RedisStorage) Save(ctx context.Context, key string, v any) error + type RemoteDeleteRequest struct + Recipient string + Timestamp int64 + type SQLiteStorage struct + func NewSQLiteStorage(dataSourceName string) (*SQLiteStorage, error) + func (s *SQLiteStorage) Delete(ctx context.Context, key string) error + func (s *SQLiteStorage) Exists(ctx context.Context, key string) (bool, error) + func (s *SQLiteStorage) Read(ctx context.Context, key string, v any) error + func (s *SQLiteStorage) Save(ctx context.Context, key string, v any) error + type SendMessageRequest struct + Base64Attachments []string + EditTimestamp *int64 + LinkPreview *LinkPreviewRequest + Mentions []string + Message string + Number string + QuoteAuthor *string + QuoteMessage *string + QuoteTimestamp *int64 + Recipients []string + ViewOnce *bool + type SendOptions struct + Base64Attachments []string + EditTimestamp int64 + LinkPreview *LinkPreview + Mentions []string + Quote *Quote + ViewOnce bool + type Storage interface + Delete func(ctx context.Context, key string) error + Exists func(ctx context.Context, key string) (bool, error) + Read func(ctx context.Context, key string, v any) error + Save func(ctx context.Context, key string, v any) error + type TypingIndicatorRequest struct + Recipient string + type UpdateContactRequest struct + ExpirationInSeconds *string + Name *string + Recipient string
Go to main page