chat

Documentation

Index

• Constants
• Variables
• type Chat
  • func NewChat() *Chat
• type Events
• type MessageReceivedEvent
• type Payload
  • func NewPayload(from, to, message string) *Payload
  • func (p *Payload) From() string
  • func (p *Payload) Message() string
  • func (p *Payload) To() string
  • func (p *Payload) Type() payload.Type

Constants

const (
	// PayloadName defines the name of the chat payload.
	PayloadName = "chat"
)

Variables

var Type = payload.NewType(payloadType, PayloadName)

Type represents the identifier which addresses the chat payload type.

Types

type Chat

type Chat struct {
	*Events
}

Chat manages chats happening over the Tangle.

func NewChat

func NewChat() *Chat

NewChat creates a new Chat.

type Events

type Events struct {
	MessageReceived *event.Event[*MessageReceivedEvent]
}

Events define events occurring within a Chat.

type MessageReceivedEvent

type MessageReceivedEvent struct {
	From      string
	To        string
	Message   string
	Timestamp time.Time
	MessageID string
}

Event defines the information passed when a chat event fires.

type Payload

type Payload struct {
	model.Immutable[Payload, *Payload, payloadModel] `serix:"0"`
}

Payload represents the chat payload type.

func NewPayload

func NewPayload(from, to, message string) *Payload

NewPayload creates a new chat payload.

func (*Payload) From

func (p *Payload) From() string

From returns an author of the message.

func (*Payload) Message

func (p *Payload) Message() string

Message returns the message contents.

func (*Payload) To

func (p *Payload) To() string

To returns a recipient of the message.

func (*Payload) Type

func (p *Payload) Type() payload.Type

Type returns the type of the Payload.