MamManager (Smack 4.3.0 API)

java.lang.Object
- org.jivesoftware.smack.Manager
- - org.jivesoftware.smackx.mam.MamManager

```
public final class MamManager
extends Manager
```
A Manager for Message Archive Management (MAM, XEP-0313).
Get an instance of a manager for a message archive
In order to work with MamManager you need to obtain an instance for a particular archive. To get the instance for the default archive on the user's server, use the getInstanceFor(XMPPConnection) method.
```
 
 XMPPConnection connection = ...
 MamManager mamManager = MamManager.getInstanceFor(connection);
 
 
```
If you want to retrieve a manager for a different archive use getInstanceFor(XMPPConnection, Jid), which takes the archive's XMPP address as second argument.
Check if MAM is supported
After you got your manager instance, you probably first want to check if MAM is supported. Simply use isSupported() to check if there is a MAM archive available.
```
 
 boolean isSupported = mamManager.isSupported();
 
 
```
Message Archive Preferences
After you have verified that the MAM is supported, you probably want to configure the archive first before using it. One of the most important preference is to enable MAM for your account. Some servers set up new accounts with MAM disabled by default. You can do so by calling enableMamForAllMessages().
Retrieve current preferences
The archive's preferences can be retrieved using retrieveArchivingPreferences().
Update preferences
Use MamManager.MamPrefsResult.asMamPrefs() to get a modifiable MamManager.MamPrefs instance. After performing the desired changes, use updateArchivingPreferences(MamPrefs) to update the preferences.
Query the message archive
Querying a message archive involves a two step process. First you need specify the query's arguments, for example a date range. The query arguments of a particular query are represented by a MamManager.MamQueryArgs instance, which can be build using MamManager.MamQueryArgs.Builder. After you have build such an instance, use queryArchive(MamQueryArgs) to issue the query.
```
 
 MamQueryArgs mamQueryArgs = MamQueryArgs.builder()
                                 .withJid(jid)
                                 .setResultPageSize(10)
                                 .queryRecentPage()
                                 .build();
 MamQuery mamQuery = mamManager.queryArchive(mamQueryArgs);
 
 
```
On success queryArchive(MamQueryArgs) returns a MamManager.MamQuery instance. The instance will hold one page of the queries result set. Use MamManager.MamQuery.getMessages() to retrieve the messages of the archive belonging to the page. You can get the whole page including all metadata using MamManager.MamQuery.getPage().
Paging through the results
Because the matching result set could be potentially very big, a MAM service will probably not return all matching messages. Instead the results are possibly send in multiple pages. To check if the result was complete or if there are further pages, use MamManager.MamQuery.isComplete(). If this method returns false, then you may want to page through the archive. MamManager.MamQuery provides convince methods to do so: MamManager.MamQuery.pageNext(int) and MamManager.MamQuery.pagePrevious(int).
```
 
 MamQuery nextPageMamQuery = mamQuery.pageNext(10);
 
 
```
Get the supported form fields
You can use retrieveFormFields() to retrieve a list of the supported additional form fields by this archive. Those fields can be used for further restrict a query.
See Also:

XEP-0313: Message Archive Management

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`MamManager.MamPrefs`
`static class`	`MamManager.MamPrefsResult` MAM preferences result class.
`class`	`MamManager.MamQuery`
`static class`	`MamManager.MamQueryArgs`
`static class`	`MamManager.MamQueryPage`
`static class`	`MamManager.MamQueryResult` Deprecated.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`MamManager.MamPrefsResult`	`enableMamForAllMessages()`
`MamManager.MamPrefsResult`	`enableMamForRosterMessages()`
`Jid`	`getArchiveAddress()` The the XMPP address of this MAM archive.
`static MamManager`	`getInstanceFor(MultiUserChat multiUserChat)` Get a MamManager for the MAM archive of the given `MultiUserChat`.
`static MamManager`	`getInstanceFor(XMPPConnection connection)` Get a MamManager for the MAM archive of the local entity (the "user") of the given connection.
`static MamManager`	`getInstanceFor(XMPPConnection connection, Jid archiveAddress)`
`String`	`getMessageUidOfLatestMessage()` Lookup the archive's message ID of the latest message in the archive.
`boolean`	`isSupported()` Check if this MamManager's archive address supports MAM.
`MamManager.MamQueryResult`	`mostRecentPage(Jid chatJid, int max)` Deprecated. use `queryMostRecentPage(Jid, int)` instead.
`MamManager.MamQueryResult`	`page(DataForm dataForm, RSMSet rsmSet)` Deprecated. use `queryArchive(MamQueryArgs)` instead.
`MamManager.MamQueryResult`	`page(String node, DataForm dataForm, RSMSet rsmSet)` Deprecated. use `queryArchive(MamQueryArgs)` instead.
`MamManager.MamQueryResult`	`pageAfter(Jid chatJid, String messageUid, int max)` Deprecated. use `queryArchive(MamQueryArgs)` instead.
`MamManager.MamQueryResult`	`pageBefore(Jid chatJid, String messageUid, int max)` Deprecated. use `queryArchive(MamQueryArgs)` instead.
`MamManager.MamQueryResult`	`pageNext(MamManager.MamQueryResult mamQueryResult, int count)` Deprecated. use `MamManager.MamQuery.pageNext(int)` instead.
`MamManager.MamQueryResult`	`pagePrevious(MamManager.MamQueryResult mamQueryResult, int count)` Deprecated. use `MamManager.MamQuery.pagePrevious(int)` instead.
`MamManager.MamQueryResult`	`queryArchive(Date start, Date end)` Deprecated. use `queryArchive(MamQueryArgs)` instead.
`MamManager.MamQueryResult`	`queryArchive(Integer max)` Deprecated. use `queryArchive(MamQueryArgs)` instead.
`MamManager.MamQueryResult`	`queryArchive(Integer max, Date start, Date end, Jid withJid, List<FormField> additionalFields)` Deprecated. use `queryArchive(MamQueryArgs)` instead.
`MamManager.MamQueryResult`	`queryArchive(Jid withJid)` Deprecated. use `queryArchive(MamQueryArgs)` instead.
`MamManager.MamQueryResult`	`queryArchive(List<FormField> additionalFields)` Deprecated. use `queryArchive(MamQueryArgs)` instead.
`MamManager.MamQuery`	`queryArchive(MamManager.MamQueryArgs mamQueryArgs)`
`MamManager.MamQueryResult`	`queryArchive(String node, Integer max, Date start, Date end, Jid withJid, List<FormField> additionalFields)` Deprecated. use `queryArchive(MamQueryArgs)` instead.
`MamManager.MamQueryResult`	`queryArchiveWithEndDate(Date end)` Deprecated. use `queryArchive(MamQueryArgs)` instead.
`MamManager.MamQueryResult`	`queryArchiveWithStartDate(Date start)` Deprecated. use `queryArchive(MamQueryArgs)` instead.
`MamManager.MamQuery`	`queryMostRecentPage(Jid jid, int max)`
`MamManager.MamPrefsResult`	`retrieveArchivingPreferences()` Get the preferences stored in the server.
`List<FormField>`	`retrieveFormFields()` Get the form fields supported by the server.
`List<FormField>`	`retrieveFormFields(String node)` Get the form fields supported by the server.
`MamManager.MamPrefsResult`	`setDefaultBehavior(MamPrefsIQ.DefaultBehavior desiredDefaultBehavior)`
`MamManager.MamPrefsResult`	`updateArchivingPreferences(List<Jid> alwaysJids, List<Jid> neverJids, MamPrefsIQ.DefaultBehavior defaultBehavior)` Deprecated. use `updateArchivingPreferences(MamPrefs)` instead.
`MamManager.MamPrefsResult`	`updateArchivingPreferences(MamManager.MamPrefs mamPrefs)` Update the preferences in the server.

Methods inherited from class org.jivesoftware.smack.Manager
connection, getAuthenticatedConnectionOrThrow, schedule

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstanceFor
```
public static MamManager getInstanceFor(XMPPConnection connection)
```
Get a MamManager for the MAM archive of the local entity (the "user") of the given connection.

Parameters:

connection - the XMPP connection to get the archive for.

Returns:

the instance of MamManager.

getInstanceFor
```
public static MamManager getInstanceFor(MultiUserChat multiUserChat)
```
Get a MamManager for the MAM archive of the given MultiUserChat. Note that not all MUCs support MAM, hence it is recommended to use isSupported() to check if MAM is supported by the MUC.

Parameters:

multiUserChat - the MultiUserChat to retrieve the MamManager for.

Returns:

the MamManager for the given MultiUserChat.

Since:

4.3.0

getInstanceFor

public static MamManager getInstanceFor(XMPPConnection connection,
                                        Jid archiveAddress)

getArchiveAddress
```
public Jid getArchiveAddress()
```
The the XMPP address of this MAM archive. Note that this method may return null if this MamManager handles the local entity's archive and if the connection has never been authenticated at least once.

Returns:

the XMPP address of this MAM archive or null.

Since:

4.3.0

queryArchive

@Deprecated
public MamManager.MamQueryResult queryArchive(Integer max)
                                                   throws SmackException.NoResponseException,
                                                          XMPPException.XMPPErrorException,
                                                          SmackException.NotConnectedException,
                                                          InterruptedException,
                                                          SmackException.NotLoggedInException

Deprecated. use queryArchive(MamQueryArgs) instead.

Query archive with a maximum amount of results.

Parameters:: max -
Returns:: the MAM query result
Throws:: SmackException.NoResponseException; XMPPException.XMPPErrorException; SmackException.NotConnectedException; InterruptedException; SmackException.NotLoggedInException

queryArchive

@Deprecated
public MamManager.MamQueryResult queryArchive(Jid withJid)
                                                   throws SmackException.NoResponseException,
                                                          XMPPException.XMPPErrorException,
                                                          SmackException.NotConnectedException,
                                                          InterruptedException,
                                                          SmackException.NotLoggedInException

Deprecated. use queryArchive(MamQueryArgs) instead.

Query archive with a JID (only messages from/to the JID).

Parameters:: withJid -
Returns:: the MAM query result
Throws:: SmackException.NoResponseException; XMPPException.XMPPErrorException; SmackException.NotConnectedException; InterruptedException; SmackException.NotLoggedInException

queryArchive

@Deprecated
public MamManager.MamQueryResult queryArchive(Date start,
                                                          Date end)
                                                   throws SmackException.NoResponseException,
                                                          XMPPException.XMPPErrorException,
                                                          SmackException.NotConnectedException,
                                                          InterruptedException,
                                                          SmackException.NotLoggedInException

Deprecated. use queryArchive(MamQueryArgs) instead.

Query archive filtering by start and/or end date. If start == null, the value of 'start' will be equal to the date/time of the earliest message stored in the archive. If end == null, the value of 'end' will be equal to the date/time of the most recent message stored in the archive.

Parameters:: start -; end -
Returns:: the MAM query result
Throws:: SmackException.NoResponseException; XMPPException.XMPPErrorException; SmackException.NotConnectedException; InterruptedException; SmackException.NotLoggedInException

queryArchive

@Deprecated
public MamManager.MamQueryResult queryArchive(List<FormField> additionalFields)
                                                   throws SmackException.NoResponseException,
                                                          XMPPException.XMPPErrorException,
                                                          SmackException.NotConnectedException,
                                                          InterruptedException,
                                                          SmackException.NotLoggedInException

Deprecated. use queryArchive(MamQueryArgs) instead.

Query Archive adding filters with additional fields.

Parameters:: additionalFields -
Returns:: the MAM query result
Throws:: SmackException.NoResponseException; XMPPException.XMPPErrorException; SmackException.NotConnectedException; InterruptedException; SmackException.NotLoggedInException

queryArchiveWithStartDate

@Deprecated
public MamManager.MamQueryResult queryArchiveWithStartDate(Date start)
                                                                throws SmackException.NoResponseException,
                                                                       XMPPException.XMPPErrorException,
                                                                       SmackException.NotConnectedException,
                                                                       InterruptedException,
                                                                       SmackException.NotLoggedInException

Deprecated. use queryArchive(MamQueryArgs) instead.

Query archive filtering by start date. The value of 'end' will be equal to the date/time of the most recent message stored in the archive.

Parameters:: start -
Returns:: the MAM query result
Throws:: SmackException.NoResponseException; XMPPException.XMPPErrorException; SmackException.NotConnectedException; InterruptedException; SmackException.NotLoggedInException

queryArchiveWithEndDate

@Deprecated
public MamManager.MamQueryResult queryArchiveWithEndDate(Date end)
                                                              throws SmackException.NoResponseException,
                                                                     XMPPException.XMPPErrorException,
                                                                     SmackException.NotConnectedException,
                                                                     InterruptedException,
                                                                     SmackException.NotLoggedInException

Deprecated. use queryArchive(MamQueryArgs) instead.

Query archive filtering by end date. The value of 'start' will be equal to the date/time of the earliest message stored in the archive.

Parameters:: end -
Returns:: the MAM query result
Throws:: SmackException.NoResponseException; XMPPException.XMPPErrorException; SmackException.NotConnectedException; InterruptedException; SmackException.NotLoggedInException

queryArchive

@Deprecated
public MamManager.MamQueryResult queryArchive(Integer max,
                                                          Date start,
                                                          Date end,
                                                          Jid withJid,
                                                          List<FormField> additionalFields)
                                                   throws SmackException.NoResponseException,
                                                          XMPPException.XMPPErrorException,
                                                          SmackException.NotConnectedException,
                                                          InterruptedException,
                                                          SmackException.NotLoggedInException

Deprecated. use queryArchive(MamQueryArgs) instead.

Query archive applying filters: max count, start date, end date, from/to JID and with additional fields.

Parameters:: max -; start -; end -; withJid -; additionalFields -
Returns:: the MAM query result
Throws:: SmackException.NoResponseException; XMPPException.XMPPErrorException; SmackException.NotConnectedException; InterruptedException; SmackException.NotLoggedInException

queryArchive

@Deprecated
public MamManager.MamQueryResult queryArchive(String node,
                                                          Integer max,
                                                          Date start,
                                                          Date end,
                                                          Jid withJid,
                                                          List<FormField> additionalFields)
                                                   throws SmackException.NoResponseException,
                                                          XMPPException.XMPPErrorException,
                                                          SmackException.NotConnectedException,
                                                          InterruptedException,
                                                          SmackException.NotLoggedInException

Deprecated. use queryArchive(MamQueryArgs) instead.

Query an message archive like a MUC archive or a PubSub node archive, addressed by an archiveAddress, applying filters: max count, start date, end date, from/to JID and with additional fields. When archiveAddress is null the default, the server will be requested.

Parameters:: node - The PubSub node name, can be null; max -; start -; end -; withJid -; additionalFields -
Returns:: the MAM query result
Throws:: SmackException.NoResponseException; XMPPException.XMPPErrorException; SmackException.NotConnectedException; InterruptedException; SmackException.NotLoggedInException

queryArchive

public MamManager.MamQuery queryArchive(MamManager.MamQueryArgs mamQueryArgs)
                                 throws SmackException.NoResponseException,
                                        XMPPException.XMPPErrorException,
                                        SmackException.NotConnectedException,
                                        SmackException.NotLoggedInException,
                                        InterruptedException

Throws:: SmackException.NoResponseException; XMPPException.XMPPErrorException; SmackException.NotConnectedException; SmackException.NotLoggedInException; InterruptedException

page

@Deprecated
public MamManager.MamQueryResult page(DataForm dataForm,
                                                  RSMSet rsmSet)
                                           throws SmackException.NoResponseException,
                                                  XMPPException.XMPPErrorException,
                                                  SmackException.NotConnectedException,
                                                  InterruptedException,
                                                  SmackException.NotLoggedInException

Deprecated. use queryArchive(MamQueryArgs) instead.

Returns a page of the archive.

Parameters:: dataForm -; rsmSet -
Returns:: the MAM query result
Throws:: SmackException.NoResponseException; XMPPException.XMPPErrorException; SmackException.NotConnectedException; InterruptedException; SmackException.NotLoggedInException

page

@Deprecated
public MamManager.MamQueryResult page(String node,
                                                  DataForm dataForm,
                                                  RSMSet rsmSet)
                                           throws SmackException.NoResponseException,
                                                  XMPPException.XMPPErrorException,
                                                  SmackException.NotConnectedException,
                                                  InterruptedException,
                                                  SmackException.NotLoggedInException

Deprecated. use queryArchive(MamQueryArgs) instead.

Returns a page of the archive. This is a low-level method, you possibly do not want to use it directly unless you know what you are doing.

Parameters:: node - The PubSub node name, can be null; dataForm -; rsmSet -
Returns:: the MAM query result
Throws:: SmackException.NoResponseException; XMPPException.XMPPErrorException; SmackException.NotConnectedException; InterruptedException; SmackException.NotLoggedInException

pageNext

@Deprecated
public MamManager.MamQueryResult pageNext(MamManager.MamQueryResult mamQueryResult,
                                                      int count)
                                               throws SmackException.NoResponseException,
                                                      XMPPException.XMPPErrorException,
                                                      SmackException.NotConnectedException,
                                                      InterruptedException,
                                                      SmackException.NotLoggedInException

Deprecated. use MamManager.MamQuery.pageNext(int) instead.

Returns the next page of the archive.

Parameters:: mamQueryResult - is the previous query result; count - is the amount of messages that a page contains
Returns:: the MAM query result
Throws:: SmackException.NoResponseException; XMPPException.XMPPErrorException; SmackException.NotConnectedException; InterruptedException; SmackException.NotLoggedInException

pagePrevious

@Deprecated
public MamManager.MamQueryResult pagePrevious(MamManager.MamQueryResult mamQueryResult,
                                                          int count)
                                                   throws SmackException.NoResponseException,
                                                          XMPPException.XMPPErrorException,
                                                          SmackException.NotConnectedException,
                                                          InterruptedException,
                                                          SmackException.NotLoggedInException

Deprecated. use MamManager.MamQuery.pagePrevious(int) instead.

Returns the previous page of the archive.

Parameters:: mamQueryResult - is the previous query result; count - is the amount of messages that a page contains
Returns:: the MAM query result
Throws:: SmackException.NoResponseException; XMPPException.XMPPErrorException; SmackException.NotConnectedException; InterruptedException; SmackException.NotLoggedInException

pageBefore

@Deprecated
public MamManager.MamQueryResult pageBefore(Jid chatJid,
                                                        String messageUid,
                                                        int max)
                                                 throws XMPPException.XMPPErrorException,
                                                        SmackException.NotLoggedInException,
                                                        SmackException.NotConnectedException,
                                                        InterruptedException,
                                                        SmackException.NoResponseException

Deprecated. use queryArchive(MamQueryArgs) instead.

Obtain page before the first message saved (specific chat).

Note that the messageUid is the XEP-0313 UID and not the stanza ID of the message.

Parameters:: chatJid -; messageUid - the UID of the message of which messages before should be received.; max -
Returns:: the MAM query result
Throws:: XMPPException.XMPPErrorException; SmackException.NotLoggedInException; SmackException.NotConnectedException; InterruptedException; SmackException.NoResponseException

pageAfter

@Deprecated
public MamManager.MamQueryResult pageAfter(Jid chatJid,
                                                       String messageUid,
                                                       int max)
                                                throws XMPPException.XMPPErrorException,
                                                       SmackException.NotLoggedInException,
                                                       SmackException.NotConnectedException,
                                                       InterruptedException,
                                                       SmackException.NoResponseException

Deprecated. use queryArchive(MamQueryArgs) instead.

Obtain page after the last message saved (specific chat).

Note that the messageUid is the XEP-0313 UID and not the stanza ID of the message.

Parameters:: chatJid -; messageUid - the UID of the message of which messages after should be received.; max -
Returns:: the MAM query result
Throws:: XMPPException.XMPPErrorException; SmackException.NotLoggedInException; SmackException.NotConnectedException; InterruptedException; SmackException.NoResponseException

mostRecentPage

@Deprecated
public MamManager.MamQueryResult mostRecentPage(Jid chatJid,
                                                            int max)
                                                     throws XMPPException.XMPPErrorException,
                                                            SmackException.NotLoggedInException,
                                                            SmackException.NotConnectedException,
                                                            InterruptedException,
                                                            SmackException.NoResponseException

Deprecated. use queryMostRecentPage(Jid, int) instead.

Obtain the most recent page of a chat.

Parameters:: chatJid -; max -
Returns:: the MAM query result
Throws:: XMPPException.XMPPErrorException; SmackException.NotLoggedInException; SmackException.NotConnectedException; InterruptedException; SmackException.NoResponseException

queryMostRecentPage

public MamManager.MamQuery queryMostRecentPage(Jid jid,
                                               int max)
                                        throws SmackException.NoResponseException,
                                               XMPPException.XMPPErrorException,
                                               SmackException.NotConnectedException,
                                               SmackException.NotLoggedInException,
                                               InterruptedException

Throws:: SmackException.NoResponseException; XMPPException.XMPPErrorException; SmackException.NotConnectedException; SmackException.NotLoggedInException; InterruptedException

retrieveFormFields

public List<FormField> retrieveFormFields()
                                   throws SmackException.NoResponseException,
                                          XMPPException.XMPPErrorException,
                                          SmackException.NotConnectedException,
                                          InterruptedException,
                                          SmackException.NotLoggedInException

Get the form fields supported by the server.

Returns:: the list of form fields.
Throws:: SmackException.NoResponseException; XMPPException.XMPPErrorException; SmackException.NotConnectedException; InterruptedException; SmackException.NotLoggedInException

retrieveFormFields

public List<FormField> retrieveFormFields(String node)
                                   throws SmackException.NoResponseException,
                                          XMPPException.XMPPErrorException,
                                          SmackException.NotConnectedException,
                                          InterruptedException,
                                          SmackException.NotLoggedInException

Get the form fields supported by the server.

Parameters:: node - The PubSub node name, can be null
Returns:: the list of form fields.
Throws:: SmackException.NoResponseException; XMPPException.XMPPErrorException; SmackException.NotConnectedException; InterruptedException; SmackException.NotLoggedInException

isSupported

public boolean isSupported()
                    throws SmackException.NoResponseException,
                           XMPPException.XMPPErrorException,
                           SmackException.NotConnectedException,
                           InterruptedException

Check if this MamManager's archive address supports MAM.

Returns:: true if MAM is supported, falseotherwise.
Throws:: SmackException.NoResponseException; XMPPException.XMPPErrorException; SmackException.NotConnectedException; InterruptedException
Since:: 4.2.1
See Also:: XEP-0313 § 7. Determining support

getMessageUidOfLatestMessage

public String getMessageUidOfLatestMessage()
                                    throws SmackException.NoResponseException,
                                           XMPPException.XMPPErrorException,
                                           SmackException.NotConnectedException,
                                           SmackException.NotLoggedInException,
                                           InterruptedException

Lookup the archive's message ID of the latest message in the archive. Returns null if the archive is empty.

Returns:: the ID of the lastest message or null.
Throws:: SmackException.NoResponseException; XMPPException.XMPPErrorException; SmackException.NotConnectedException; SmackException.NotLoggedInException; InterruptedException
Since:: 4.3.0

retrieveArchivingPreferences

public MamManager.MamPrefsResult retrieveArchivingPreferences()
                                                       throws SmackException.NoResponseException,
                                                              XMPPException.XMPPErrorException,
                                                              SmackException.NotConnectedException,
                                                              InterruptedException,
                                                              SmackException.NotLoggedInException

Get the preferences stored in the server.

Returns:: the MAM preferences result
Throws:: SmackException.NoResponseException; XMPPException.XMPPErrorException; SmackException.NotConnectedException; InterruptedException; SmackException.NotLoggedInException

updateArchivingPreferences

@Deprecated
public MamManager.MamPrefsResult updateArchivingPreferences(List<Jid> alwaysJids,
                                                                        List<Jid> neverJids,
                                                                        MamPrefsIQ.DefaultBehavior defaultBehavior)
                                                                 throws SmackException.NoResponseException,
                                                                        XMPPException.XMPPErrorException,
                                                                        SmackException.NotConnectedException,
                                                                        InterruptedException,
                                                                        SmackException.NotLoggedInException

Deprecated. use updateArchivingPreferences(MamPrefs) instead.

Update the preferences in the server.

Parameters:: alwaysJids - is the list of JIDs that should always have messages to/from archived in the user's store; neverJids - is the list of JIDs that should never have messages to/from archived in the user's store; defaultBehavior - can be "roster", "always", "never" (see XEP-0313)
Returns:: the MAM preferences result
Throws:: SmackException.NoResponseException; XMPPException.XMPPErrorException; SmackException.NotConnectedException; InterruptedException; SmackException.NotLoggedInException

updateArchivingPreferences

public MamManager.MamPrefsResult updateArchivingPreferences(MamManager.MamPrefs mamPrefs)
                                                     throws SmackException.NoResponseException,
                                                            XMPPException.XMPPErrorException,
                                                            SmackException.NotConnectedException,
                                                            InterruptedException,
                                                            SmackException.NotLoggedInException

Update the preferences in the server.

Parameters:: mamPrefs -
Returns:: the currently active preferences after the operation.
Throws:: SmackException.NoResponseException; XMPPException.XMPPErrorException; SmackException.NotConnectedException; InterruptedException; SmackException.NotLoggedInException
Since:: 4.3.0

enableMamForAllMessages

public MamManager.MamPrefsResult enableMamForAllMessages()
                                                  throws SmackException.NoResponseException,
                                                         XMPPException.XMPPErrorException,
                                                         SmackException.NotConnectedException,
                                                         SmackException.NotLoggedInException,
                                                         InterruptedException

Throws:: SmackException.NoResponseException; XMPPException.XMPPErrorException; SmackException.NotConnectedException; SmackException.NotLoggedInException; InterruptedException

enableMamForRosterMessages

public MamManager.MamPrefsResult enableMamForRosterMessages()
                                                     throws SmackException.NoResponseException,
                                                            XMPPException.XMPPErrorException,
                                                            SmackException.NotConnectedException,
                                                            SmackException.NotLoggedInException,
                                                            InterruptedException

Throws:: SmackException.NoResponseException; XMPPException.XMPPErrorException; SmackException.NotConnectedException; SmackException.NotLoggedInException; InterruptedException

setDefaultBehavior

public MamManager.MamPrefsResult setDefaultBehavior(MamPrefsIQ.DefaultBehavior desiredDefaultBehavior)
                                             throws SmackException.NoResponseException,
                                                    XMPPException.XMPPErrorException,
                                                    SmackException.NotConnectedException,
                                                    SmackException.NotLoggedInException,
                                                    InterruptedException

Throws:: SmackException.NoResponseException; XMPPException.XMPPErrorException; SmackException.NotConnectedException; SmackException.NotLoggedInException; InterruptedException

Class MamManager

Get an instance of a manager for a message archive

Check if MAM is supported

Message Archive Preferences

Retrieve current preferences

Update preferences

Query the message archive

Paging through the results

Get the supported form fields

Nested Class Summary

Method Summary

Methods inherited from class org.jivesoftware.smack.Manager

Methods inherited from class java.lang.Object

Method Detail

getInstanceFor

getInstanceFor

getInstanceFor

getArchiveAddress

queryArchive

queryArchive

queryArchive

queryArchive

queryArchiveWithStartDate

queryArchiveWithEndDate

queryArchive

queryArchive

queryArchive

page

page

pageNext

pagePrevious

pageBefore

pageAfter

mostRecentPage

queryMostRecentPage

retrieveFormFields

retrieveFormFields

isSupported

getMessageUidOfLatestMessage

retrieveArchivingPreferences

updateArchivingPreferences

updateArchivingPreferences

enableMamForAllMessages

enableMamForRosterMessages

setDefaultBehavior