Class Message

Inheritance Relationships

Base Type

Class Documentation

class Message : public axr::sdk::EntityBase

Public Functions

inline Message()
inline Message(const Message &value)
inline Message(Message &&value)
inline virtual ~Message()
inline virtual Message &SetProperties(const std::map<utility::string_t, Variant> &value) override

Sets the object’s underlying map of stored values.

inline virtual Message &SetProperties(std::map<utility::string_t, Variant> &&value) override

Sets the underlying map of stored values for the object.

inline virtual Message &SetProperty(const utility::char_t *name, const Variant &value) override

Sets the property of the given name to the provided value.

inline virtual Message &SetProperty(const utility::string_t &name, const Variant &value) override

Sets the property of the given name to the provided value.

inline virtual Message &SetRemoteUrl(const utility::string_t &url) override

Returns the URL of the remote server endpoint where the object is managed.

inline virtual Message &SetUid(const utility::string_t &value) override

Sets the value of the Uid property.

Parameters

value – The value to set.

inline virtual Message &SetDateCreated(const datetime &value) override

Sets the value of the DateCreated property.

Parameters

value – The value to set.

inline virtual Message &SetDateModified(const datetime &value) override

Sets the value of the DateModified property.

Parameters

value – The value to set.

inline virtual Message &SetVersion(const uint64_t value) override

Sets the value of the Version property.

Parameters

value – The value to set.

virtual void Validate() override
utility::string_t GetReceiverUid() const

Returns the unique identifier of the user that is to receive the message.

Message &SetReceiverUid(const utility::string_t &value)

Sets the unique identifier of the user that is to receive the message.

utility::string_t GetSenderUid() const

Returns the unique identifier of the user that sent the message.

Message &SetSenderUid(const utility::string_t &value)

Sets the unique identifier of the user that sent the message.

utility::string_t GetSubject() const

Returns the summary of the message contents.

Message &SetSubject(const utility::string_t &value)

Sets the summary of the message contents.

utility::string_t GetBody() const

Returns the message contents.

Message &SetBody(const utility::string_t &value)

Sets the message contents.

std::shared_ptr<Object> GetAttachments() const

Returns the map of key-value pairs representing a list of attachments that have been appended to the message.

Message &SetAttachments(std::shared_ptr<Object> value)

Sets the map of key-value pairs representing a list of attachments that have been appended to the message.

bool HasRead() const

Indicates if the user has read the message before.

Message &SetHasRead(bool value)

Set to true to indicate that the user has read the message before.

Public Static Functions

static inline const utility::char_t *ClassName()

Returns the fully qualified name of the class.