channels

Dec 19, 2023

Changes in this version

+ const SendInviteTag

+ const SendSilentTag

+ type AllowLists struct

+ AllowWithTags map[MessageType]struct{}

+ AllowWithoutTags map[MessageType]struct{}

+ type CMIXChannelInvitation struct

+ InviteLink string

+ Password string

+ Text string

+ Version uint32

+ func (*CMIXChannelInvitation) Descriptor() ([]byte, []int)

+ func (*CMIXChannelInvitation) ProtoMessage()

+ func (x *CMIXChannelInvitation) GetInviteLink() string

+ func (x *CMIXChannelInvitation) GetPassword() string

+ func (x *CMIXChannelInvitation) GetText() string

+ func (x *CMIXChannelInvitation) GetVersion() uint32

+ func (x *CMIXChannelInvitation) ProtoReflect() protoreflect.Message

+ func (x *CMIXChannelInvitation) Reset()

+ func (x *CMIXChannelInvitation) String() string

+ type CMIXChannelSilentMessage struct

+ Version uint32

+ func (*CMIXChannelSilentMessage) Descriptor() ([]byte, []int)

+ func (*CMIXChannelSilentMessage) ProtoMessage()

+ func (x *CMIXChannelSilentMessage) GetVersion() uint32

+ func (x *CMIXChannelSilentMessage) ProtoReflect() protoreflect.Message

+ func (x *CMIXChannelSilentMessage) Reset()

+ func (x *CMIXChannelSilentMessage) String() string

type Client

+ UpsertCompressedService func(clientID *id.ID, newService message.CompressedService, ...)

type ExtensionMessageHandler

+ GetNotificationTags func(channelID *id.ID, level NotificationLevel) (asymmetric, symmetric AllowLists)

type Manager

+ GetNotificationLevel func(channelID *id.ID) (NotificationLevel, error)

+ GetNotificationStatus func(channelID *id.ID) (clientNotif.NotificationState, error)

+ SendInvite func(channelID *id.ID, msg string, inviteTo *cryptoBroadcast.Channel, host string, ...) (message.ID, rounds.Round, ephemeral.Id, error)

+ SendSilent func(channelID *id.ID, validUntil time.Duration, params cmix.CMIXParams) (message.ID, rounds.Round, ephemeral.Id, error)

+ SetMobileNotificationsLevel func(channelID *id.ID, level NotificationLevel, ...) error

type MessageType

+ const Invitation

+ const Silent

+ func UnmarshalMessageType(b [2]byte) MessageType

+ func (mt MessageType) Marshal() [2]byte

+ type NotificationCallback func(nfs []NotificationFilter, changedNotificationStates []NotificationState, ...)

+ type NotificationFilter struct

+ ChannelID *id.ID

+ Identifier []byte

+ Tags []string

+ type NotificationInfo struct

+ Metadata []byte

+ Status bool

+ type NotificationLevel uint8

+ const NotifyAll

+ const NotifyNone

+ const NotifyPing

+ func UnmarshalNotificationLevel(b []byte) NotificationLevel

+ func (nl NotificationLevel) Marshal() []byte

+ func (nl NotificationLevel) String() string

+ type NotificationReport struct

+ Channel *id.ID

+ PingType PingType

+ Type MessageType

+ func GetNotificationReportsForMe(nfs []NotificationFilter, notificationData []*primNotif.Data) []NotificationReport

+ type NotificationState struct

+ ChannelID *id.ID

+ Level NotificationLevel

+ Status clientNotif.NotificationState

+ type NotificationsManager interface

+ Delete func(toBeNotifiedOn *id.ID) error

+ Get func(toBeNotifiedOn *id.ID) (status clientNotif.NotificationState, metadata []byte, group string, ...)

+ RegisterUpdateCallback func(group string, nu clientNotif.Update)

+ Set func(toBeNotifiedOn *id.ID, group string, metadata []byte, ...) error

+ type PingType string

+ const GenericPing

+ const MentionPing

+ const ReplyPing

+ type UiCallbacks interface

+ AdminKeysUpdate func(chID *id.ID, isAdmin bool)

+ ChannelUpdate func(channelID *id.ID, deleted bool)

+ DmTokenUpdate func(chID *id.ID, sendToken bool)

+ MessageDeleted func(messageID message.ID)

+ MessageReceived func(uuid int64, channelID *id.ID, update bool)

+ NicknameUpdate func(channelId *id.ID, nickname string, exists bool)

+ NotificationUpdate func(nfs []NotificationFilter, changedNotificationStates []NotificationState, ...)

+ UserMuted func(channelID *id.ID, pubKey ed25519.PublicKey, unmute bool)

Apr 26, 2023

Changes in this version

+ var NoMessageErr = errors.New("message does not exist [EV]")

+ func CheckNoMessageErr(err error) bool

+ type ActionSaver struct

+ func NewActionSaver(triggerFn triggerActionEventFunc, kv *versioned.KV) *ActionSaver

+ func (as *ActionSaver) AddAction(channelID *id.ID, messageID, targetMessage message.ID, action MessageType, ...) error

+ func (as *ActionSaver) CheckSavedActions(channelID *id.ID, targetMessage message.ID) (UpdateActionFn, bool)

+ func (as *ActionSaver) RemoveChannel(channelID *id.ID) error

+ func (as *ActionSaver) StartProcesses() (stoppable.Stoppable, error)

+ type ExtensionBuilder func(e EventModel, m Manager, me cryptoChannel.PrivateIdentity) ([]ExtensionMessageHandler, error)

+ type ExtensionMessageHandler interface

+ GetProperties func() (name string, userSpace, adminSpace, mutedSpace bool)

+ GetType func() MessageType

+ Handle func(channelID *id.ID, messageID cryptoMessage.ID, messageType MessageType, ...) uint64

type MessageType

+ const FileTransfer

+ type UpdateActionFn func() (uint64, error)

Mar 10, 2023

Changes in this version

type Manager

+ func LoadManagerBuilder(storageTag string, kv *versioned.KV, net Client, rng *fastRNG.StreamGenerator, ...) (Manager, error)

+ func NewManagerBuilder(identity cryptoChannel.PrivateIdentity, kv *versioned.KV, net Client, ...) (Manager, error)

+ AreDMsEnabled func(chId *id.ID) bool

Jan 19, 2023

Changes in this version

+ const MessageLife

+ const SendAdminReplayTag

+ const SendDeleteTag

+ const SendMuteTag

+ const SendPinnedTag

+ var NotAnAdminErr = errors.New("user not a member of the channel")

+ var WrongPasswordErr = errors.New("incorrect password")

+ var WrongPrivateKeyErr = errors.New("the passed private key does not match the channel")

+ func LoadOrNewNicknameManager(kv *versioned.KV) *nicknameManager

+ type ActionLeaseList struct

+ func NewActionLeaseList(triggerFn triggerActionEventFunc, store *CommandStore, kv *versioned.KV, ...) *ActionLeaseList

+ func NewOrLoadActionLeaseList(triggerFn triggerActionEventFunc, store *CommandStore, kv *versioned.KV, ...) (*ActionLeaseList, error)

+ func (all *ActionLeaseList) AddMessage(channelID *id.ID, messageID message.ID, action MessageType, ...) error

+ func (all *ActionLeaseList) AddOrOverwrite(channelID *id.ID, action MessageType, payload []byte) error

+ func (all *ActionLeaseList) RegisterReplayFn(replayFn ReplayActionFunc)

+ func (all *ActionLeaseList) RemoveChannel(channelID *id.ID)

+ func (all *ActionLeaseList) RemoveMessage(channelID *id.ID, messageID message.ID, action MessageType, ...) error

+ func (all *ActionLeaseList) StartProcesses() (stoppable.Stoppable, error)

+ type AddServiceFn func(sp xxdk.Service) error

+ type CMIXChannelDelete struct

+ MessageID []byte

+ Version uint32

+ func (*CMIXChannelDelete) Descriptor() ([]byte, []int)

+ func (*CMIXChannelDelete) ProtoMessage()

+ func (x *CMIXChannelDelete) GetMessageID() []byte

+ func (x *CMIXChannelDelete) GetVersion() uint32

+ func (x *CMIXChannelDelete) ProtoReflect() protoreflect.Message

+ func (x *CMIXChannelDelete) Reset()

+ func (x *CMIXChannelDelete) String() string

+ type CMIXChannelMute struct

+ PubKey []byte

+ UndoAction bool

+ Version uint32

+ func (*CMIXChannelMute) Descriptor() ([]byte, []int)

+ func (*CMIXChannelMute) ProtoMessage()

+ func (x *CMIXChannelMute) GetPubKey() []byte

+ func (x *CMIXChannelMute) GetUndoAction() bool

+ func (x *CMIXChannelMute) GetVersion() uint32

+ func (x *CMIXChannelMute) ProtoReflect() protoreflect.Message

+ func (x *CMIXChannelMute) Reset()

+ func (x *CMIXChannelMute) String() string

+ type CMIXChannelPinned struct

+ MessageID []byte

+ UndoAction bool

+ Version uint32

+ func (*CMIXChannelPinned) Descriptor() ([]byte, []int)

+ func (*CMIXChannelPinned) ProtoMessage()

+ func (x *CMIXChannelPinned) GetMessageID() []byte

+ func (x *CMIXChannelPinned) GetUndoAction() bool

+ func (x *CMIXChannelPinned) GetVersion() uint32

+ func (x *CMIXChannelPinned) ProtoReflect() protoreflect.Message

+ func (x *CMIXChannelPinned) Reset()

+ func (x *CMIXChannelPinned) String() string

type ChannelMessage

+ DMToken uint32

+ func (x *ChannelMessage) GetDMToken() uint32

+ type CommandMessage struct

+ ChannelID *id.ID

+ Codeset uint8

+ Content []byte

+ EncryptedPayload []byte

+ FromAdmin bool

+ Lease time.Duration

+ MessageID message.ID

+ MessageType MessageType

+ Nickname string

+ OriginatingRound id.Round

+ OriginatingTimestamp time.Time

+ PubKey ed25519.PublicKey

+ Round rounds.Round

+ Status SentStatus

+ Timestamp time.Time

+ UserMuted bool

+ type CommandStore struct

+ func NewCommandStore(kv *versioned.KV) *CommandStore

+ func (cs *CommandStore) DeleteCommand(channelID *id.ID, messageType MessageType, content []byte) error

+ func (cs *CommandStore) LoadCommand(channelID *id.ID, messageType MessageType, content []byte) (*CommandMessage, error)

+ func (cs *CommandStore) SaveCommand(channelID *id.ID, messageID message.ID, messageType MessageType, ...) error

type EventModel

+ DeleteMessage func(messageID message.ID) error

+ GetMessage func(messageID message.ID) (ModelMessage, error)

+ MuteUser func(channelID *id.ID, pubKey ed25519.PublicKey, unmute bool)

+ UpdateFromMessageID func(messageID message.ID, timestamp *time.Time, round *rounds.Round, ...) uint64

+ UpdateFromUUID func(uuid uint64, messageID *message.ID, timestamp *time.Time, round *rounds.Round, ...)

type Manager

+ DeleteChannelAdminKey func(channelID *id.ID) error

+ DeleteMessage func(channelID *id.ID, targetMessage message.ID, params cmix.CMIXParams) (message.ID, rounds.Round, ephemeral.Id, error)

+ DisableDirectMessages func(chId *id.ID) error

+ EnableDirectMessages func(chId *id.ID) error

+ ExportChannelAdminKey func(channelID *id.ID, encryptionPassword string) ([]byte, error)

+ GenerateChannel func(name, description string, privacyLevel cryptoBroadcast.PrivacyLevel) (*cryptoBroadcast.Channel, error)

+ GetMutedUsers func(channelID *id.ID) []ed25519.PublicKey

+ ImportChannelAdminKey func(channelID *id.ID, encryptionPassword string, encryptedPrivKey []byte) error

+ IsChannelAdmin func(channelID *id.ID) bool

+ MuteUser func(channelID *id.ID, mutedUser ed25519.PublicKey, undoAction bool, ...) (message.ID, rounds.Round, ephemeral.Id, error)

+ Muted func(channelID *id.ID) bool

+ PinMessage func(channelID *id.ID, targetMessage message.ID, undoAction bool, ...) (message.ID, rounds.Round, ephemeral.Id, error)

+ VerifyChannelAdminKey func(channelID *id.ID, encryptionPassword string, encryptedPrivKey []byte) (bool, error)

type MessageType

+ const AdminReplay

+ const Delete

+ const Mute

+ const Pinned

+ func (mt MessageType) Bytes() []byte

+ type ModelMessage struct

+ ChannelID *id.ID

+ CodesetVersion uint8

+ Content []byte

+ DmToken uint32

+ Hidden bool

+ Lease time.Duration

+ MessageID message.ID

+ Nickname string

+ ParentMessageID message.ID

+ Pinned bool

+ PubKey ed25519.PublicKey

+ Round id.Round

+ Status SentStatus

+ Timestamp time.Time

+ Type MessageType

+ UUID uint64

+ type ReceiveMessageHandler struct

+ func NewReceiveMessageHandler(name string, listener MessageTypeReceiveMessage, ...) *ReceiveMessageHandler

+ func (rmh *ReceiveMessageHandler) CheckSpace(user, admin, muted bool) error

+ func (rmh *ReceiveMessageHandler) SpaceString() string

+ type ReplayActionFunc func(channelID *id.ID, encryptedPayload []byte)

+ type UpdateFromUuidFunc func(uuid uint64, messageID *message.ID, timestamp *time.Time, round *rounds.Round, ...)

Nov 10, 2022

Changes in this version

+ const AdminUsername

+ const SendMessageTag

+ const SendReactionTag

+ const SendReplyTag

+ var AdminFakePubKey = ed25519.PublicKey

+ var ChannelAlreadyExistsErr = errors.New("the channel cannot be added because it already exists")

+ var ChannelDoesNotExistsErr = errors.New("the channel cannot be found")

+ var File_channelMessages_proto protoreflect.FileDescriptor

+ var File_text_proto protoreflect.FileDescriptor

+ var InvalidReaction = errors.New("The reaction is not valid, it must be a single emoji")

+ var MessageTooLongErr = errors.New("the passed message is too long")

+ var MessageTypeAlreadyRegistered = errors.New("the given message type has already been registered")

+ var ValidForever = time.Duration(math.MaxInt64)

+ var WrongPrivateKey = errors.New("the passed private key does not match the channel")

+ func IsNicknameValid(nick string) error

+ func ValidateReaction(reaction string) error

+ type CMIXChannelReaction struct

+ Reaction string

+ ReactionMessageID []byte

+ Version uint32

+ func (*CMIXChannelReaction) Descriptor() ([]byte, []int)

+ func (*CMIXChannelReaction) ProtoMessage()

+ func (x *CMIXChannelReaction) GetReaction() string

+ func (x *CMIXChannelReaction) GetReactionMessageID() []byte

+ func (x *CMIXChannelReaction) GetVersion() uint32

+ func (x *CMIXChannelReaction) ProtoReflect() protoreflect.Message

+ func (x *CMIXChannelReaction) Reset()

+ func (x *CMIXChannelReaction) String() string

+ type CMIXChannelText struct

+ ReplyMessageID []byte

+ Text string

+ Version uint32

+ func (*CMIXChannelText) Descriptor() ([]byte, []int)

+ func (*CMIXChannelText) ProtoMessage()

+ func (x *CMIXChannelText) GetReplyMessageID() []byte

+ func (x *CMIXChannelText) GetText() string

+ func (x *CMIXChannelText) GetVersion() uint32

+ func (x *CMIXChannelText) ProtoReflect() protoreflect.Message

+ func (x *CMIXChannelText) Reset()

+ func (x *CMIXChannelText) String() string

+ type ChannelMessage struct

+ Lease int64

+ LocalTimestamp int64

+ Nickname string

+ Nonce []byte

+ Payload []byte

+ PayloadType uint32

+ RoundID uint64

+ func (*ChannelMessage) Descriptor() ([]byte, []int)

+ func (*ChannelMessage) ProtoMessage()

+ func (x *ChannelMessage) GetLease() int64

+ func (x *ChannelMessage) GetLocalTimestamp() int64

+ func (x *ChannelMessage) GetNickname() string

+ func (x *ChannelMessage) GetNonce() []byte

+ func (x *ChannelMessage) GetPayload() []byte

+ func (x *ChannelMessage) GetPayloadType() uint32

+ func (x *ChannelMessage) GetRoundID() uint64

+ func (x *ChannelMessage) ProtoReflect() protoreflect.Message

+ func (x *ChannelMessage) Reset()

+ func (x *ChannelMessage) String() string

+ type Client interface

+ AddHealthCallback func(f func(bool)) uint64

+ AddIdentity func(id *id.ID, validUntil time.Time, persistent bool)

+ AddIdentityWithHistory func(id *id.ID, validUntil, beginning time.Time, persistent bool)

+ AddService func(clientID *id.ID, newService message.Service, response message.Processor)

+ DeleteClientService func(clientID *id.ID)

+ GetMaxMessageLength func() int

+ GetRoundResults func(timeout time.Duration, roundCallback cmix.RoundEventCallback, ...)

+ IsHealthy func() bool

+ RemoveHealthCallback func(uint64)

+ RemoveIdentity func(id *id.ID)

+ SendWithAssembler func(recipient *id.ID, assembler cmix.MessageAssembler, cmixParams cmix.CMIXParams) (rounds.Round, ephemeral.Id, error)

+ type EventModel interface

+ JoinChannel func(channel *cryptoBroadcast.Channel)

+ LeaveChannel func(channelID *id.ID)

+ ReceiveMessage func(channelID *id.ID, messageID cryptoChannel.MessageID, nickname, text string, ...) uint64

+ ReceiveReaction func(channelID *id.ID, messageID cryptoChannel.MessageID, ...) uint64

+ ReceiveReply func(channelID *id.ID, messageID cryptoChannel.MessageID, ...) uint64

+ UpdateSentStatus func(uuid uint64, messageID cryptoChannel.MessageID, timestamp time.Time, ...)

+ type EventModelBuilder func(path string) (EventModel, error)

+ type Manager interface

+ DeleteNickname func(chID *id.ID) error

+ ExportPrivateIdentity func(password string) ([]byte, error)

+ GetChannel func(chID *id.ID) (*cryptoBroadcast.Channel, error)

+ GetChannels func() []*id.ID

+ GetIdentity func() cryptoChannel.Identity

+ GetNickname func(chID *id.ID) (nickname string, exists bool)

+ GetStorageTag func() string

+ JoinChannel func(channel *cryptoBroadcast.Channel) error

+ LeaveChannel func(channelID *id.ID) error

+ RegisterReceiveHandler func(messageType MessageType, listener MessageTypeReceiveMessage) error

+ ReplayChannel func(chID *id.ID) error

+ SendAdminGeneric func(privKey rsa.PrivateKey, channelID *id.ID, messageType MessageType, msg []byte, ...) (cryptoChannel.MessageID, rounds.Round, ephemeral.Id, error)

+ SendGeneric func(channelID *id.ID, messageType MessageType, msg []byte, ...) (cryptoChannel.MessageID, rounds.Round, ephemeral.Id, error)

+ SendMessage func(channelID *id.ID, msg string, validUntil time.Duration, params cmix.CMIXParams) (cryptoChannel.MessageID, rounds.Round, ephemeral.Id, error)

+ SendReaction func(channelID *id.ID, reaction string, reactTo cryptoChannel.MessageID, ...) (cryptoChannel.MessageID, rounds.Round, ephemeral.Id, error)

+ SendReply func(channelID *id.ID, msg string, replyTo cryptoChannel.MessageID, ...) (cryptoChannel.MessageID, rounds.Round, ephemeral.Id, error)

+ SetNickname func(newNick string, chID *id.ID) error

+ func LoadManager(storageTag string, kv *versioned.KV, net Client, rng *fastRNG.StreamGenerator, ...) (Manager, error)

+ func NewManager(identity cryptoChannel.PrivateIdentity, kv *versioned.KV, net Client, ...) (Manager, error)

+ type MessageType uint32

+ const AdminText

+ const Reaction

+ const Text

+ func (mt MessageType) String() string

+ type MessageTypeReceiveMessage func(channelID *id.ID, messageID cryptoChannel.MessageID, messageType MessageType, ...) uint64

+ type NameService interface

+ GetChannelPubkey func() ed25519.PublicKey

+ GetChannelValidationSignature func() ([]byte, time.Time)

+ GetUsername func() string

+ SignChannelMessage func(message []byte) (signature []byte, err error)

+ ValidateChannelMessage func(username string, lease time.Time, pubKey ed25519.PublicKey, ...) bool

+ func NewDummyNameService(username string, rng io.Reader) (NameService, error)

+ type SentStatus uint8

+ const Delivered

+ const Failed

+ const Sent

+ const Unsent

+ func (ss SentStatus) String() string

+ type UserMessage struct

+ ECCPublicKey []byte

+ Message []byte

+ Signature []byte

+ func (*UserMessage) Descriptor() ([]byte, []int)

+ func (*UserMessage) ProtoMessage()

+ func (x *UserMessage) GetECCPublicKey() []byte

+ func (x *UserMessage) GetMessage() []byte

+ func (x *UserMessage) GetSignature() []byte

+ func (x *UserMessage) ProtoReflect() protoreflect.Message

+ func (x *UserMessage) Reset()

+ func (x *UserMessage) String() string