Converse converse.js

API Documentation

Module: converse-rsm

XEP-0059 Result Set Management Some code taken from the Strophe RSM plugin, licensed under the MIT License Copyright 2006-2017 Strophe (https://github.com/strophe/strophejs)

Copyright:
  • The Converse.js contributors
License:
  • Mozilla Public License (MPLv2)
Source:

Classes

RSM
RSM
RSM

Type Definitions

ArchiveQueryOptions

The options that can be passed in to the _converse.api.archive.query method

Type:
  • module:converse-mam~MAMFilterParameters
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:

MAMOptions

A map of MAM related options that may be passed to fetchArchivedMessages

Type:
  • Object
Source:

MAMQueryResult

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

An instance of 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:

RSMQueryParameters

XEP-0059 RSM Attributes that can be used to filter query results

Type:
  • Object
Properties:
Name Type Attributes Default Description
after String <optional>

The XEP-0359 stanza ID of a message after which messages should be returned. Implies forward paging.
before String <optional>

The XEP-0359 stanza ID of a message before which messages should be returned. Implies backward paging.
index number <optional>
 0

The index of the results page to return.
max number <optional>

The maximum number of items to return.
Source:

RSMQueryParameters

XEP-0059 RSM Attributes that can be used to filter query results

Type:
  • Object
Properties:
Name Type Attributes Default Description
after String <optional>

The XEP-0359 stanza ID of a message after which messages should be returned. Implies forward paging.
before String <optional>

The XEP-0359 stanza ID of a message before which messages should be returned. Implies backward paging.
index number <optional>
 0

The index of the results page to return.
max number <optional>

The maximum number of items to return.
Source:

XEP-0059 Result Set Management Some code taken from the Strophe RSM plugin, licensed under the MIT License Copyright 2006-2017 Strophe (https://github.com/strophe/strophejs)

Copyright:
  • The Converse.js contributors
License:
  • Mozilla Public License (MPLv2)
Source:

Classes

RSM
RSM
RSM

Type Definitions

ArchiveQueryOptions

The options that can be passed in to the _converse.api.archive.query method

Type:
  • module:converse-mam~MAMFilterParameters
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:

MAMOptions

A map of MAM related options that may be passed to fetchArchivedMessages

Type:
  • Object
Source:

MAMQueryResult

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

An instance of 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:

RSMQueryParameters

XEP-0059 RSM Attributes that can be used to filter query results

Type:
  • Object
Properties:
Name Type Attributes Default Description
after String <optional>

The XEP-0359 stanza ID of a message after which messages should be returned. Implies forward paging.
before String <optional>

The XEP-0359 stanza ID of a message before which messages should be returned. Implies backward paging.
index number <optional>
 0

The index of the results page to return.
max number <optional>

The maximum number of items to return.
Source:

RSMQueryParameters

XEP-0059 RSM Attributes that can be used to filter query results

Type:
  • Object
Properties:
Name Type Attributes Default Description
after String <optional>

The XEP-0359 stanza ID of a message after which messages should be returned. Implies forward paging.
before String <optional>

The XEP-0359 stanza ID of a message before which messages should be returned. Implies backward paging.
index number <optional>
 0

The index of the results page to return.
max number <optional>

The maximum number of items to return.
Source: