Documentation
¶
Overview ¶
Package xmpp provides the means to send and receive instant messages to and from users of XMPP-compatible services.
To send a message,
m := &xmpp.Message{
To: []string{"kaylee@example.com"},
Body: `Hi! How's the carrot?`,
}
err := m.Send(c)
To receive messages,
func init() {
xmpp.Handle(handleChat)
}
func handleChat(c appengine.Context, m *xmpp.Message) {
// ...
}
Index ¶
- Variables
- func GetPresence(c appengine.Context, to string, from string) (string, error)
- func GetPresenceMulti(c appengine.Context, to []string, from string) ([]string, error)
- func Handle(f func(c appengine.Context, m *Message))
- func Invite(c appengine.Context, to, from string) error
- type Message
- type Presence
Constants ¶
This section is empty.
Variables ¶
var (
ErrPresenceUnavailable = errors.New("xmpp: presence unavailable")
ErrInvalidJID = errors.New("xmpp: invalid JID")
)
Functions ¶
func GetPresence ¶
func GetPresence(c appengine.Context, to string, from string) (string, error)
GetPresence retrieves a user's presence. If the from address is an empty string the default (yourapp@appspot.com/bot) will be used. Possible return values are "", "away", "dnd", "chat", "xa". ErrPresenceUnavailable is returned if the presence is unavailable.
func GetPresenceMulti ¶
func GetPresenceMulti(c appengine.Context, to []string, from string) ([]string, error)
GetPresenceMulti retrieves multiple users' presence. If the from address is an empty string the default (yourapp@appspot.com/bot) will be used. Possible return values are "", "away", "dnd", "chat", "xa". If any presence is unavailable, an appengine.MultiError is returned
Types ¶
type Message ¶
type Message struct {
// Sender is the JID of the sender.
// Optional for outgoing messages.
Sender string
// To is the intended recipients of the message.
// Incoming messages will have exactly one element.
To []string
// Body is the body of the message.
Body string
// Type is the message type, per RFC 3921.
// It defaults to "chat".
Type string
// RawXML is whether the body contains raw XML.
RawXML bool
}
Message represents an incoming chat message.
type Presence ¶
type Presence struct {
// Sender is the JID (optional).
Sender string
// The intended recipient of the presence update.
To string
// Type, per RFC 3921 (optional). Defaults to "available".
Type string
// State of presence (optional).
// Valid values: "away", "chat", "xa", "dnd" (RFC 3921).
State string
// Free text status message (optional).
Status string
}
Presence represents an outgoing presence update.
Source Files