tri

README

tri

Trinity message service interfaces.

Documentation

Index

• Variables
• func IsValidContent(content []Paragraph) bool
• func IsValidReferenceString(s string) bool
• func Version() string
• type Message
  • func NewMessage(senderID string, content []Paragraph) (m Message)
  • func (m *Message) Plaintext() string
• type Name
• type Neko
• type Paragraph
  • func ParagraphFile(rs string) Paragraph
  • func ParagraphText(text string) Paragraph
  • func (p *Paragraph) IsValid() bool
• type ParagraphType
  • func (pt ParagraphType) String() string
• type Reference
  • func (ref *Reference) IsValid() bool
  • func (ref *Reference) MarshalString() (s string, err error)
  • func (ref *Reference) String() (s string)
  • func (ref *Reference) UnmarshalString(s string) (err error)

Variables

var (
	ErrInvalidReference = errors.New("invalid reference")
)

Functions

func IsValidContent

func IsValidContent(content []Paragraph) bool

func IsValidReferenceString

func IsValidReferenceString(s string) bool

func Version

func Version() string

Types

type Message

type Message struct {
	ID string `json:"id"`
	// Timestamp is the unix millisecond timestamp of sending
	Timestamp int64       `json:"timestamp"`
	SenderID  string      `json:"sender_id"`
	Content   []Paragraph `json:"content"`
}

func NewMessage

func NewMessage(senderID string, content []Paragraph) (m Message)

NewMessage uses a new UUID as ID and the timestamp of now as Timestamp

func (*Message) Plaintext

func (m *Message) Plaintext() string

type Name

type Name struct {
	DisplayName       string `json:"display_name"`
	UserPrincipalName string `json:"user_principal_name"`
}

type Neko

type Neko struct {
	ID   string `json:"id"`
	Name Name   `json:"name"`
}

type Paragraph

type Paragraph struct {
	Type ParagraphType `json:"type"`
	Data string        `json:"data"`
}

func ParagraphFile

func ParagraphFile(rs string) Paragraph

func ParagraphText

func ParagraphText(text string) Paragraph

func (*Paragraph) IsValid

func (p *Paragraph) IsValid() bool

type ParagraphType

type ParagraphType uint8

const (
	ParagraphTypeText ParagraphType = iota + 1
	ParagraphTypeFile
)

func (ParagraphType) String

func (pt ParagraphType) String() string

type Reference

type Reference struct {
	Name string `json:"name"`
	ID   string `json:"id"`
}

func (*Reference) IsValid

func (ref *Reference) IsValid() bool

func (*Reference) MarshalString

func (ref *Reference) MarshalString() (s string, err error)

func (*Reference) String

func (ref *Reference) String() (s string)

func (*Reference) UnmarshalString

func (ref *Reference) UnmarshalString(s string) (err error)