QXmpp::Muc::HistoryOptions Class

class QXmpp::Muc::HistoryOptions

History options for joining a XEP-0045: Multi-User Chat room (§7.2.13). More...

Header:	`#include <QXmppMucData.h>`
Since:	QXmpp 1.16

List of all members, including inherited members

Public Functions

std::optional<int>	maxChars() const
std::optional<int>	maxStanzas() const
std::optional<int>	seconds() const
void	setMaxChars(std::optional<int> value)
void	setMaxStanzas(std::optional<int> value)
void	setSeconds(std::optional<int> value)
void	setSince(std::optional<QDateTime> value)
std::optional<QDateTime>	since() const

Detailed Description

This class allows you to restrict the room history sent to the client upon joining. All options are optional; if none are set, the server's default history is sent.

Member Function Documentation

std::optional<int> HistoryOptions::maxChars() const

Returns the maximum number of characters of history to request, or std::nullopt if unrestricted.

See also setMaxChars().

std::optional<int> HistoryOptions::maxStanzas() const

Returns the maximum number of history stanzas to request, or std::nullopt if unrestricted.

See also setMaxStanzas().

std::optional<int> HistoryOptions::seconds() const

Returns the seconds window for history, or std::nullopt if unrestricted.

See also setSeconds().

void HistoryOptions::setMaxChars(std::optional<int> value)

Sets the maximum number of characters of history to request to value. Pass std::nullopt for unrestricted.

See also maxChars().

void HistoryOptions::setMaxStanzas(std::optional<int> value)

Sets the maximum number of history stanzas to request to value. Pass std::nullopt for unrestricted.

See also maxStanzas().

void HistoryOptions::setSeconds(std::optional<int> value)

Sets the seconds window for history to value. Pass std::nullopt for unrestricted.

See also seconds().

void HistoryOptions::setSince(std::optional<QDateTime> value)

Sets the earliest time to include in history to value. Pass std::nullopt for unrestricted.

See also since().

std::optional<QDateTime> HistoryOptions::since() const

Returns the earliest time to include in history, or std::nullopt if unrestricted.

See also setSince().

Contents