Mercury-IM/Smack
Mercury-IM/Smack
1
0
Fork 0
mirror of https://codeberg.org/Mercury-IM/Smack synced 2024-11-22 14:22:05 +01:00
Code Issues Releases Wiki Activity

Improve MamManager javadoc

Browse source
This commit is contained in:
Florian Schmaus 2017-03-10 12:07:21 +01:00
parent 1c5c8e32d9
commit a8c6de6b98
1 changed files with 12 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
smack-experimental/src/main/java/org/jivesoftware/smackx/mam/MamManager.java
View file

@ -411,9 +411,12 @@ public final class MamManager extends Manager {
/** /**
* Obtain page before the first message saved (specific chat). * Obtain page before the first message saved (specific chat).
* <p>
* Note that the messageUid is the XEP-0313 UID and <b>not</> the stanza ID of the message.
* </p>
* *
* @param chatJid * @param chatJid
* @param firstMessageId * @param messageUid the UID of the message of which messages before should be received.
* @param max * @param max
* @return the MAM query result * @return the MAM query result
* @throws XMPPErrorException * @throws XMPPErrorException
@ -422,9 +425,9 @@ public final class MamManager extends Manager {
* @throws InterruptedException * @throws InterruptedException
* @throws NoResponseException * @throws NoResponseException
*/ */
public MamQueryResult pageBefore(Jid chatJid, String firstMessageId, int max) throws XMPPErrorException, public MamQueryResult pageBefore(Jid chatJid, String messageUid, int max) throws XMPPErrorException,
NotLoggedInException, NotConnectedException, InterruptedException, NoResponseException { NotLoggedInException, NotConnectedException, InterruptedException, NoResponseException {
RSMSet rsmSet = new RSMSet(null, firstMessageId, -1, -1, null, max, null, -1); RSMSet rsmSet = new RSMSet(null, messageUid, -1, -1, null, max, null, -1);
DataForm dataForm = getNewMamForm(); DataForm dataForm = getNewMamForm();
addWithJid(chatJid, dataForm); addWithJid(chatJid, dataForm);
return page(null, dataForm, rsmSet); return page(null, dataForm, rsmSet);
@ -432,9 +435,12 @@ public final class MamManager extends Manager {
/** /**
* Obtain page after the last message saved (specific chat). * Obtain page after the last message saved (specific chat).
* <p>
* Note that the messageUid is the XEP-0313 UID and <b>not</> the stanza ID of the message.
* </p>
* *
* @param chatJid * @param chatJid
* @param lastMessageId * @param messageUid the UID of the message of which messages after should be received.
* @param max * @param max
* @return the MAM query result * @return the MAM query result
* @throws XMPPErrorException * @throws XMPPErrorException
@ -443,9 +449,9 @@ public final class MamManager extends Manager {
* @throws InterruptedException * @throws InterruptedException
* @throws NoResponseException * @throws NoResponseException
*/ */
public MamQueryResult pageAfter(Jid chatJid, String lastMessageId, int max) throws XMPPErrorException, public MamQueryResult pageAfter(Jid chatJid, String messageUid, int max) throws XMPPErrorException,
NotLoggedInException, NotConnectedException, InterruptedException, NoResponseException { NotLoggedInException, NotConnectedException, InterruptedException, NoResponseException {
RSMSet rsmSet = new RSMSet(lastMessageId, null, -1, -1, null, max, null, -1); RSMSet rsmSet = new RSMSet(messageUid, null, -1, -1, null, max, null, -1);
DataForm dataForm = getNewMamForm(); DataForm dataForm = getNewMamForm();
addWithJid(chatJid, dataForm); addWithJid(chatJid, dataForm);
return page(null, dataForm, rsmSet); return page(null, dataForm, rsmSet);