• PrivateMessagePayload

    • Contents

    PrivateMessagePayload Class

    Represents a single private message exchanged between two users. More...

    Header: #include <PrivateMessagePayload>

    Properties

    Public Functions

    PrivateMessagePayload(const QJsonObject &json)
    QDateTime authoredAt() const
    int id() const
    QString message() const
    QString ownerId() const
    QString recipient() const
    QString recipientId() const
    void setAuthoredAt(const QDateTime &datetime)
    void setId(int id)
    void setMessage(const QString &message)
    void setOwnerId(const QString &id)
    void setRecipient(const QString &recipient)
    void setRecipientId(const QString &recipientId)
    void setUsername(const QString &username)
    QString username() const

    Detailed Description

    Property Documentation

    authoredAt : QDateTime

    Returns the timestamp when the message was authored.

    Access functions:

    QDateTime authoredAt() const
    void setAuthoredAt(const QDateTime &datetime)

    id : int

    Returns the unique message ID.

    Access functions:

    int id() const
    void setId(int id)

    message : QString

    Returns the body of the private message.

    Access functions:

    QString message() const
    void setMessage(const QString &message)

    ownerId : QString

    Returns the sender's user ID.

    Access functions:

    QString ownerId() const
    void setOwnerId(const QString &id)

    recipient : QString

    Returns the recipient's display name.

    Access functions:

    QString recipient() const
    void setRecipient(const QString &recipient)

    recipientId : QString

    Returns the recipient's user ID.

    Access functions:

    QString recipientId() const
    void setRecipientId(const QString &recipientId)

    username : QString

    Returns the sender's display name.

    Access functions:

    QString username() const
    void setUsername(const QString &username)

    Member Function Documentation

    [explicit] PrivateMessagePayload::PrivateMessagePayload(const QJsonObject &json)

    Constructs a PrivateMessagePayload from json object.

    void PrivateMessagePayload::setAuthoredAt(const QDateTime &datetime)

    Sets the authored timestamp to datetime.

    datetime is the time the private message was authored

    Note: Setter function for property authoredAt.

    See also authoredAt().

    void PrivateMessagePayload::setId(int id)

    Sets the message ID to id.

    id is a unique message ID

    Note: Setter function for property id.

    See also id().

    void PrivateMessagePayload::setMessage(const QString &message)

    Sets the message body to message.

    message is the text content of the private message

    Note: Setter function for property message.

    See also message().

    void PrivateMessagePayload::setOwnerId(const QString &id)

    Sets the sender's user ID to id.

    The id is the senders unique user ID

    Note: Setter function for property ownerId.

    See also ownerId().

    void PrivateMessagePayload::setRecipient(const QString &recipient)

    Sets the recipient's display name to recipient.

    recipient is the recipient's username

    Note: Setter function for property recipient.

    See also recipient().

    void PrivateMessagePayload::setRecipientId(const QString &recipientId)

    Sets the recipient's user ID to recipientId.

    recipientId is the recipients unique user ID

    Note: Setter function for property recipientId.

    See also recipientId().

    void PrivateMessagePayload::setUsername(const QString &username)

    Sets the sender's display name to username.

    username is the sender's username

    Note: Setter function for property username.

    See also username().