XEP 0313¶

class slixmpp.plugins.xep_0313.XEP_0313(xmpp, config=None)[source]¶

XEP-0313 Message Archive Management

retrieve(jid=None, start=None, end=None, with_jid=None, ifrom=None, reverse=False, timeout=None, callback=None, iterator=False, rsm=None)[source]¶

Send a MAM query and retrieve the results.

Parameters

jid (JID) – Entity holding the MAM records
start,end (datetime) – MAM query temporal boundaries
with_jid (JID) – Filter results on this JID
ifrom (JID) – To change the from address of the query
reverse (bool) – Get the results in reverse order
timeout (int) – IQ timeout
callback (func) – Custom callback for handling results
iterator (bool) – Use RSM and iterate over a paginated query
rsm (dict) – RSM custom options

Return type

Awaitable

stanza = <module 'slixmpp.plugins.xep_0313.stanza' from '/home/docs/checkouts/readthedocs.org/user_builds/slixmpp/checkouts/slix-1.6.0/slixmpp/plugins/xep_0313/stanza.py'>¶

Stanza elements¶

See the file LICENSE for copying permissio

class slixmpp.plugins.xep_0313.stanza.Fin(xml=None, parent=None)[source]¶

name = 'fin'¶

namespace = 'urn:xmpp:mam:2'¶

plugin_attrib = 'mam_fin'¶

class slixmpp.plugins.xep_0313.stanza.MAM(xml=None, parent=None)[source]¶

del_results()[source]¶

get_end()[source]¶

get_results()[source]¶

get_start()[source]¶

get_with()[source]¶

interfaces = {'end', 'queryid', 'results', 'start', 'with'}¶

name = 'query'¶

namespace = 'urn:xmpp:mam:2'¶

plugin_attrib = 'mam'¶

set_end(value)[source]¶

set_results(values)[source]¶

set_start(value)[source]¶

set_with(value)[source]¶

setup(xml=None)[source]¶

Initialize the stanza’s XML contents.

Will return True if XML was generated according to the stanza’s definition instead of building a stanza object from an existing XML object.

Parameters: xml – An existing XML object to use for the stanza’s content instead of generating new XML.

sub_interfaces = {'end', 'start', 'with'}¶

class slixmpp.plugins.xep_0313.stanza.Preferences(xml=None, parent=None)[source]¶

get_always()[source]¶

get_never()[source]¶

interfaces = {'always', 'default', 'never'}¶

name = 'prefs'¶

namespace = 'urn:xmpp:mam:2'¶

plugin_attrib = 'mam_prefs'¶

set_always(value)[source]¶

set_never(value)[source]¶

sub_interfaces = {'always', 'never'}¶

class slixmpp.plugins.xep_0313.stanza.Result(xml=None, parent=None)[source]¶

interfaces = {'id', 'queryid'}¶

name = 'result'¶

namespace = 'urn:xmpp:mam:2'¶

plugin_attrib = 'mam_result'¶

XEP 0313

1.6 Documentation

XEP 0313¶

Stanza elements¶