privatexml

Documentation

Overview

Package privatexml implements storage of arbitrary data on the server.

New uses of this package should likely use mellium.im/xmpp/pubsub instead unless backwards compatibility with other legacy specifications is desired.

Index

• Constants
• func Get(ctx context.Context, s *xmpp.Session, name xml.Name) (xmlstream.TokenReadCloser, error)
• func GetIQ(ctx context.Context, iq stanza.IQ, s *xmpp.Session, name xml.Name) (xmlstream.TokenReadCloser, error)
• func Set(ctx context.Context, s *xmpp.Session, r xml.TokenReader) error
• func SetIQ(ctx context.Context, iq stanza.IQ, s *xmpp.Session, r xml.TokenReader) error

Constants

const NS = `jabber:iq:private`

NS is the namespace used by this package.

Functions

func Get

func Get(ctx context.Context, s *xmpp.Session, name xml.Name) (xmlstream.TokenReadCloser, error)

Get requests XML that was previously stored on the server.

func GetIQ

func GetIQ(ctx context.Context, iq stanza.IQ, s *xmpp.Session, name xml.Name) (xmlstream.TokenReadCloser, error)

GetIQ is like Get except that the IQ stanza can be customized. Changing the type of the stanza has no effect.

func Set

func Set(ctx context.Context, s *xmpp.Session, r xml.TokenReader) error

Set stores the XML copied from r on the server for later retrieval.

func SetIQ

func SetIQ(ctx context.Context, iq stanza.IQ, s *xmpp.Session, r xml.TokenReader) error

SetIQ is like Set except that the IQ stanza can be customized. Changing the type of the stanza has no effect.