public final class OfflineMessageManager extends Manager
This manager covers the use cases of XEP-0013: Flexible Offline Message Retrieval.
Offline Message Retrieval must be used before sending initial presence, in order to tell the server, that it must not flood the client with offline messages later.
Enabling or disabling this manager has no effect.Modifier and Type | Method and Description |
---|---|
AsyncResult<java.lang.Boolean> |
isSupported()
Discovers support for flexible offline message retrieval.
|
AsyncResult<IQ> |
removeAllMessages()
Removes all offline messages.
|
AsyncResult<IQ> |
removeMessages(java.lang.String... ids)
Removes specific offline messages.
|
AsyncResult<IQ> |
requestAllMessages()
Requests all offline messages.
|
AsyncResult<IQ> |
requestMessage(java.lang.String id)
Requests a specific offline message.
|
AsyncResult<java.util.List<OfflineMessageHeader>> |
requestMessageHeaders()
Gets the offline message headers.
|
AsyncResult<java.lang.Integer> |
requestNumberOfMessages()
Gets the number of offline messages.
|
isEnabled, setEnabled
public AsyncResult<java.lang.Boolean> isSupported()
Discovers support for flexible offline message retrieval.
public AsyncResult<java.lang.Integer> requestNumberOfMessages()
Gets the number of offline messages.
public AsyncResult<java.util.List<OfflineMessageHeader>> requestMessageHeaders()
Gets the offline message headers.
public AsyncResult<IQ> requestMessage(java.lang.String id)
Requests a specific offline message. The message will be sent in a normal way and contains the OfflineMessage
extension, which can be used to match the id OfflineMessage.getId()
.
id
- The offline message id, which corresponds to OfflineMessageHeader.getId()
public AsyncResult<IQ> removeMessages(java.lang.String... ids)
Removes specific offline messages.
ids
- The offline message ids, which correspond to OfflineMessageHeader.getId()
public AsyncResult<IQ> requestAllMessages()
Requests all offline messages.
public AsyncResult<IQ> removeAllMessages()
Removes all offline messages.
Copyright © 2014–2019 XMPP.rocks. All rights reserved.