Method Detail

• isSupported

  public boolean isSupported()
                      throws XmppException

  Discovers support for flexible offline message retrieval.

  Returns:

  True, if the server supports flexible offline message retrieval; otherwise false.

  Throws:

  StanzaException - If the server returned a stanza error.

  NoResponseException - If the server did not respond.

  XmppException

• requestNumberOfMessages

  public int requestNumberOfMessages()
                              throws XmppException

  Gets the number of offline messages.

  Returns:

  The number of offline messages.

  Throws:

  StanzaException - If the server returned a stanza error.

  NoResponseException - If the server did not respond.

  XmppException

  See Also:

  2.2 Requesting Number of Messages

• requestMessageHeaders

  public List<OfflineMessageHeader> requestMessageHeaders()
                                                   throws XmppException

  Gets the offline message headers.

  Returns:

  The list of message headers.

  Throws:

  StanzaException - If the server returned a stanza error.

  NoResponseException - If the server did not respond.

  XmppException

  See Also:

  2.3 Requesting Message Headers

• requestMessage

  public void requestMessage(String id)
                      throws XmppException

  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().

  Parameters:

  id - The offline message id, which corresponds to OfflineMessageHeader.getId()

  Throws:

  StanzaException - If the server returned a stanza error.

  NoResponseException - If the server did not respond.

  XmppException

  See Also:

  2.4 Retrieving Specific Messages

• removeMessages

  public void removeMessages(String... ids)
                      throws XmppException

  Removes specific offline messages.

  Parameters:

  ids - The offline message ids, which correspond to OfflineMessageHeader.getId()

  Throws:

  StanzaException - If the server returned a stanza error.

  NoResponseException - If the server did not respond.

  XmppException

  See Also:

  2.5 Removing Specific Messages

• requestAllMessages

  public void requestAllMessages()
                          throws XmppException

  Requests all offline messages.

  Throws:

  StanzaException - If the server returned a stanza error.

  NoResponseException - If the server did not respond.

  XmppException

  See Also:

  2.6 Retrieving All Messages

• removeAllMessages

  public void removeAllMessages()
                         throws XmppException

  Removes all offline messages.

  Throws:

  StanzaException - If the server returned a stanza error.

  NoResponseException - If the server did not respond.

  XmppException

  See Also:

  2.7 Removing All Messages