roster

Documentation

Overview

Package roster implements contact list functionality.

Index

• Constants
• type IQ
  • func (iq IQ) MarshalXML(e *xml.Encoder, _ xml.StartElement) error
  • func (iq IQ) TokenReader() xml.TokenReader
  • func (iq IQ) WriteXML(w xmlstream.TokenWriter) (n int, err error)
• type Item
  • func (item Item) MarshalXML(e *xml.Encoder, _ xml.StartElement) error
  • func (item Item) TokenReader() xml.TokenReader
  • func (item Item) WriteXML(w xmlstream.TokenWriter) (n int, err error)

Constants

const (
	NS = "jabber:iq:roster"
)

Namespaces used by this package provided as a convenience.

Types

type IQ

type IQ struct {
	stanza.IQ

	Query struct {
		Ver  string `xml:"version,attr,omitempty"`
		Item []Item `xml:"item"`
	} `xml:"jabber:iq:roster query"`
}

IQ represents a user roster request or response. The zero value is a valid query for the roster.

func (IQ) MarshalXML

func (iq IQ) MarshalXML(e *xml.Encoder, _ xml.StartElement) error

MarshalXML satisfies the xml.Marshaler interface.

func (IQ) TokenReader

func (iq IQ) TokenReader() xml.TokenReader

TokenReader satisfies the xmlstream.Marshaler interface.

func (IQ) WriteXML

func (iq IQ) WriteXML(w xmlstream.TokenWriter) (n int, err error)

WriteXML satisfies the xmlstream.WriterTo interface. It is like MarshalXML except it writes tokens to w.

type Item

type Item struct {
	JID          jid.JID `xml:"jid,attr,omitempty"`
	Name         string  `xml:"name,attr,omitempty"`
	Subscription string  `xml:"subscription,attr,omitempty"`
	Group        string  `xml:"group,omitempty"`
}

Item represents a contact in the roster.

func (Item) MarshalXML

func (item Item) MarshalXML(e *xml.Encoder, _ xml.StartElement) error

MarshalXML satisfies the xml.Marshaler interface.

func (Item) TokenReader

func (item Item) TokenReader() xml.TokenReader

TokenReader satisfies the xmlstream.Marshaler interface.

func (Item) WriteXML

func (item Item) WriteXML(w xmlstream.TokenWriter) (n int, err error)

WriteXML satisfies the xmlstream.WriterTo interface. It is like MarshalXML except it writes tokens to w.