sfs3::event::InvitationReply Struct Reference

Dispatched to the inviter when one of the users he invited replies to the invitation, and when an invitation left unanswered expires. More...

#include <SFSEvent.h>

Public Attributes
std::shared_ptr< entities::User >	invitee
	The user who replied.
entities::InvitationReply	reply
	The reply of the invitee: ACCEPT, REFUSE or EXPIRED.
std::shared_ptr< entities::SFSObject >	data
	The custom parameters the invitee attached to his reply, or nullptr if none.

Detailed Description

Dispatched to the inviter when one of the users he invited replies to the invitation, and when an invitation left unanswered expires.

It is caused by a requests::inv::InvitationReplyRequest from the invitee.

One event is dispatched per invited user. Invitations sent with a requests::inv::JoinRoomInvitationRequest are the exception: those only report a REFUSE or an EXPIRED reply, because an acceptance shows as the invitee entering the Room instead.

See also

requests::inv::InvitationReplyRequest

entities::InvitationReply

SFSEvent::INVITATION

SFSEvent::INVITATION_REPLY_ERROR

Member Data Documentation

invitee

std::shared_ptr<entities::User> sfs3::event::InvitationReply::invitee

The user who replied.

When he is unknown to this client (he is in none of the Rooms the client joined) this is a detached snapshot, not a managed instance.

data

std::shared_ptr<entities::SFSObject> sfs3::event::InvitationReply::data

The custom parameters the invitee attached to his reply, or nullptr if none.

For example, a message that explains the reason of a refusal.

---

The documentation for this struct was generated from the following file:

• event/SFSEvent.h