Converse converse.js

API Documentation

Module: converse-mam

XEP-0313 Message Archive Management

Copyright:
  • 2020, the Converse.js contributors
License:
  • Mozilla Public License (MPLv2)
Source:

Mixins

MAMEnabledChat

Type Definitions

ArchiveQueryOptions

The options that can be passed in to the { @link _converse.api.archive.query } method

Type:
Properties:
Name Type Attributes Default Description
groupchat Boolean <optional>
 false

Whether the MAM archive is for a groupchat.
Source:

MAMFilterParameters

Filter parameters which can be used to filter a MAM XEP-0313 archive

Type:
Properties:
Name Type Attributes Description
end String <optional>

A date string in ISO-8601 format, before which messages should be returned. Implies backward paging.
start String <optional>

A date string in ISO-8601 format, after which messages should be returned. Implies forward paging.
with String <optional>

A JID against which to match messages, according to either their to or from attributes. An item in a MUC archive matches if the publisher of the item matches the JID. If with is omitted, all messages that match the rest of the query will be returned, regardless of to/from addresses of each message.
Source:

MAMQueryResult

Type:
  • Object
Properties:
Name Type Attributes Description
messages Array
rsm RSM <optional>

An instance of { @link RSM }. You can call next() or previous() on this instance, to get the RSM query parameters for the next or previous page in the result set.
complete Boolean
error Error <optional>
Source: