event

Documentation

Index

• Constants
• type C2SStreamEventInfo
• type ExternalComponentEventInfo
• type MemberListEventInfo
• type OfflineEventInfo
• type PrivateEventInfo
• type RosterEventInfo
• type S2SStreamEventInfo
• type UserEventInfo
• type VCardEventInfo

Constants

const (
	// C2SStreamRegistered event is posted when a C2S connection is registered.
	C2SStreamRegistered = "c2s.stream.registered"

	// C2SStreamBounded event is posted when C2S stream is bounded.
	C2SStreamBounded = "c2s.stream.bounded"

	// C2SStreamUnregistered event is posted when a C2S connection is unregistered.
	C2SStreamUnregistered = "c2s.stream.unregistered"

	// C2SStreamStanzaReceived event is posted whenever a stanza is received over a C2S stream.
	C2SStreamStanzaReceived = "c2s.stream.stanza_received"

	// C2SStreamIQReceived event is posted whenever an iq stanza is received over a C2S stream.
	C2SStreamIQReceived = "c2s.stream.iq_received"

	// C2SStreamPresenceReceived event is posted whenever a presence stanza is received over a C2S stream.
	C2SStreamPresenceReceived = "c2s.stream.presence_received"

	// C2SStreamMessageReceived event is posted whenever a message stanza is received over a C2S stream.
	C2SStreamMessageReceived = "c2s.stream.message_received"

	// C2SStreamMessageUnrouted event is posted whenever a previously received message stanza could not be routed
	// because no destination available resource was found.
	C2SStreamMessageUnrouted = "c2s.stream.message_unrouted"
)

const (
	// ExternalComponentRegistered event is posted when a external component connection is registered.
	ExternalComponentRegistered = "ext_component.stream.registered"

	// ExternalComponentUnregistered event is posted when a external component connection is unregistered.
	ExternalComponentUnregistered = "ext_component.stream.unregistered"

	// ExternalComponentStanzaReceived event is posted whenever a stanza is received over a external component stream.
	ExternalComponentStanzaReceived = "ext_component.stream.stanza_received"
)

const (
	// PrivateFetched event is posted whenever a user private XML is fetched.
	PrivateFetched = "private.fetched"

	// PrivateUpdated event is posted whenever a user private XML is updated.
	PrivateUpdated = "private.updated"
)

const (
	// RosterRequested event is posted whenever a user requests the roster.
	RosterRequested = "roster.requested"

	// RosterItemUpdated event is posted whenever a roster item subscription is updated.
	RosterItemUpdated = "roster.item.updated"
)

const (
	// S2SOutStreamRegistered event is posted when an outgoing S2S connection is registered.
	S2SOutStreamRegistered = "s2s.out.stream.registered"

	// S2SOutStreamUnregistered event is posted when an outgoing S2S connection is unregistered.
	S2SOutStreamUnregistered = "s2s.out.stream.unregistered"

	// S2SOutStreamStanzaSent event is posted whenever a stanza is sent over an outgoing S2S stream.
	S2SOutStreamStanzaSent = "s2s.out.stream.stanza_sent"

	// S2SInStreamRegistered event is posted when an incoming S2S connection is registered.
	S2SInStreamRegistered = "s2s.in.stream.registered"

	// S2SInStreamUnregistered event is posted when an incoming S2S connection is unregistered.
	S2SInStreamUnregistered = "s2s.in.stream.unregistered"

	// S2SInStreamStanzaReceived event is posted whenever a stanza is received over an incoming S2S stream.
	S2SInStreamStanzaReceived = "s2s.in.stream.stanza_received"

	// S2SInStreamIQReceived event is posted whenever an iq stanza is received over an incoming S2S stream.
	S2SInStreamIQReceived = "s2s.in.stream.iq_received"

	// S2SInStreamPresenceReceived event is posted whenever a presence stanza is received over an incoming S2S stream.
	S2SInStreamPresenceReceived = "s2s.in.stream.presence_received"

	// S2SInStreamMessageReceived event is posted whenever a message stanza is received over an incoming S2S stream.
	S2SInStreamMessageReceived = "s2s.in.stream.message_received"

	// S2SStreamMessageUnrouted event is posted whenever a previously received message stanza could not be routed
	// because no destination available resource was found.
	S2SStreamMessageUnrouted = "s2s.in.stream.message_unrouted"
)

const (
	// UserCreated event is posted whenever a new user is created.
	UserCreated = "user.created"

	// UserDeleted event is posted whenever a user is deleted.
	UserDeleted = "user.deleted"
)

const (
	// VCardFetched event is posted whenever a user vCard is fetched.
	VCardFetched = "vcard.fetched"

	// VCardUpdated event is posted whenever a user vCard is updated.
	VCardUpdated = "vcard.updated"
)

const (
	// MemberListUpdated event is posted whenever cluster member list is updated.
	MemberListUpdated = "memberlist.updated"
)

const (
	// OfflineMessageArchived event is posted whenever an offline message is archived.
	OfflineMessageArchived = "offline.message.archieved"
)

Types

type C2SStreamEventInfo

type C2SStreamEventInfo struct {
	// ID is the event stream identifier.
	ID string

	// JID represents the event associated JID.
	JID *jid.JID

	// Stanza represents the event associated stanza.
	Stanza stravaganza.Stanza
}

C2SStreamEventInfo contains all info associated to a C2S stream event.

type ExternalComponentEventInfo

type ExternalComponentEventInfo struct {
	// ID is the event stream identifier.
	ID string

	// Host is the external component host domain.
	Host string

	// Stanza represents the event associated stanza.
	Stanza stravaganza.Stanza
}

ExternalComponentEventInfo contains all info associated to an external component event.

type MemberListEventInfo

type MemberListEventInfo struct {
	// Registered contains all new registered cluster members.
	Registered []model.ClusterMember

	// UnregisteredKeys contains unregistered cluster members keys.
	UnregisteredKeys []string
}

MemberListEventInfo contains all info associated to MemberListUpdated event.

type OfflineEventInfo

type OfflineEventInfo struct {
	// Username is the name of the vCard user associated to this event.
	Username string

	// Message represents the event associated message.
	Message *stravaganza.Message
}

OfflineEventInfo contains all information associated to an offline event.

type PrivateEventInfo

type PrivateEventInfo struct {
	// Username is the name of the user associated to this event.
	Username string

	// Private is the private XML element associated to this event.
	Private stravaganza.Element
}

PrivateEventInfo contains all information associated to a private event.

type RosterEventInfo

type RosterEventInfo struct {
	// Username is the name of the roster owner.
	Username string

	// JID is the event contact JID.
	JID string

	// Subscription is the roster event subscription value.
	Subscription string
}

RosterEventInfo contains all information associated to a roster event.

type S2SStreamEventInfo

type S2SStreamEventInfo struct {
	// ID is the event stream identifier.
	ID string

	// Sender is the S2S sender domain.
	Sender string

	// Target is the S2S target domain.
	Target string

	// Stanza represents the event associated stanza.
	Stanza stravaganza.Stanza
}

S2SStreamEventInfo contains all info associated to a S2S event.

type UserEventInfo

type UserEventInfo struct {
	// Username is the name of the user associated to this event.
	Username string
}

UserEventInfo contains all information associated to a user event.

type VCardEventInfo

type VCardEventInfo struct {
	// Username is the name of the vCard user associated to this event.
	Username string

	// VCard is the vCard element associated to this event.
	VCard stravaganza.Element
}

VCardEventInfo contains all information associated to a vCard event.