signal

Documentation

Index

• Constants
• func DesktopDir(betaApp bool) (string, error)
• type Attachment
• type Avatar
• type Contact
• type Context
  • func Open(betaApp bool, dir string, encKey *safestorage.RawEncryptionKey) (*Context, error)
  • func (c *Context) CheckDatabase() ([]string, error)
  • func (c *Context) Close()
  • func (c *Context) ConversationAttachments(conv *Conversation, ival Interval) ([]Attachment, error)
  • func (c *Context) ConversationMessages(conv *Conversation, ival Interval) ([]Message, error)
  • func (c *Context) Conversations() ([]Conversation, error)
  • func (c *Context) DatabaseKey() ([]byte, error)
  • func (c *Context) EncryptionKey() ([]byte, error)
  • func (c *Context) QueryDatabase(sql string) ([][]string, error)
  • func (c *Context) ReadAvatar(avt *Avatar) ([]byte, error)
  • func (c *Context) WriteAttachment(att *Attachment, w io.Writer) error
  • func (c *Context) WriteDatabase(path string) error
• type Conversation
• type Edit
• type ErrMention
  • func (e *ErrMention) Error() string
• type Group
• type Interval
• type Mention
• type Message
  • func (m *Message) IsOutgoing() bool
• type MessageBody
• type Quote
• type QuoteAttachment
• type Reaction
• type Recipient
  • func (r *Recipient) DetailedDisplayName() string
  • func (r *Recipient) DisplayName() string
• type RecipientType

Constants

const (
	DatabaseFile  = "sql" + string(os.PathSeparator) + "db.sqlite"
	ConfigFile    = "config.json"
	AttachmentDir = "attachments.noindex"

	AppName     = "Signal"
	AppNameBeta = "Signal Beta"

	// Content type of the long-text attachment of a long message
	LongTextType = "text/x-signal-plain"

	// Avatar for the Signal release chat
	SignalAvatarPath = "images/profile-avatar.svg"
)

Functions

func DesktopDir

func DesktopDir(betaApp bool) (string, error)

Types

type Attachment

type Attachment struct {
	FileName    string
	ContentType string
	TimeSent    int64
	TimeRecv    int64
	Pending     bool
	// contains filtered or unexported fields
}

type Avatar

type Avatar struct {
	// contains filtered or unexported fields
}

Based on ContactAvatarType in ts/types/Avatar.ts in the Signal-Desktop repository

type Contact

type Contact struct {
	ACI               string // Account Identity
	Name              string
	ProfileName       string
	ProfileFamilyName string
	ProfileJoinedName string
	Phone             string
	Username          string
}

type Context

type Context struct {
	// contains filtered or unexported fields
}

func Open

func Open(betaApp bool, dir string, encKey *safestorage.RawEncryptionKey) (*Context, error)

func (*Context) CheckDatabase

func (c *Context) CheckDatabase() ([]string, error)

func (*Context) Close

func (c *Context) Close()

func (*Context) ConversationAttachments

func (c *Context) ConversationAttachments(conv *Conversation, ival Interval) ([]Attachment, error)

func (*Context) ConversationMessages

func (c *Context) ConversationMessages(conv *Conversation, ival Interval) ([]Message, error)

func (*Context) Conversations

func (c *Context) Conversations() ([]Conversation, error)

func (*Context) DatabaseKey

func (c *Context) DatabaseKey() ([]byte, error)

func (*Context) EncryptionKey

func (c *Context) EncryptionKey() ([]byte, error)

func (*Context) QueryDatabase

func (c *Context) QueryDatabase(sql string) ([][]string, error)

func (*Context) ReadAvatar

func (c *Context) ReadAvatar(avt *Avatar) ([]byte, error)

func (*Context) WriteAttachment

func (c *Context) WriteAttachment(att *Attachment, w io.Writer) error

func (*Context) WriteDatabase

func (c *Context) WriteDatabase(path string) error

type Conversation

type Conversation struct {
	ID        string
	Recipient *Recipient
}

type Edit

type Edit struct {
	Body        MessageBody
	Attachments []Attachment
	Quote       *Quote
	TimeEdit    int64
}

type ErrMention

type ErrMention struct {
	Msg   string
	Index int
	Body  *MessageBody
}

func (*ErrMention) Error

func (e *ErrMention) Error() string

type Group

type Group struct {
	ID   string
	Name string
}

type Interval

type Interval struct {
	Min time.Time
	Max time.Time
}

type Mention

type Mention struct {
	Start     int
	Length    int
	Recipient *Recipient
}

type Message

type Message struct {
	Conversation *Recipient
	Source       *Recipient
	TimeSent     int64
	TimeRecv     int64
	Type         string
	Body         MessageBody
	JSON         string
	Attachments  []Attachment
	Reactions    []Reaction
	Quote        *Quote
	Edits        []Edit
}

func (*Message) IsOutgoing

func (m *Message) IsOutgoing() bool

type MessageBody

type MessageBody struct {
	Text     string
	Mentions []Mention
}

type Quote

type Quote struct {
	ID          int64
	Recipient   *Recipient
	Body        MessageBody
	Attachments []QuoteAttachment
}

type QuoteAttachment

type QuoteAttachment struct {
	FileName    string
	ContentType string
}

type Reaction

type Reaction struct {
	Recipient *Recipient
	TimeSent  int64
	TimeRecv  int64
	Emoji     string
}

type Recipient

type Recipient struct {
	Type    RecipientType
	Contact Contact
	Group   Group
	Avatar  Avatar
}

func (*Recipient) DetailedDisplayName

func (r *Recipient) DetailedDisplayName() string

func (*Recipient) DisplayName

func (r *Recipient) DisplayName() string

type RecipientType

type RecipientType int

const (
	RecipientTypeContact RecipientType = iota
	RecipientTypeGroup
)