sfs3::requests::UnsubscribeRoomGroupRequest Class Reference

Unsubscribes the current user from Room-related events occurring in the specified Group. More...

#include <UnsubscribeRoomGroupRequest.h>

Inheritance diagram for sfs3::requests::UnsubscribeRoomGroupRequest:

Public Member Functions
	UnsubscribeRoomGroupRequest (std::string groupId)
	Creates a new UnsubscribeRoomGroupRequest.

Detailed Description

Unsubscribes the current user from Room-related events occurring in the specified Group.

This allows the user to stop being notified of specific Room events occurring in Rooms belonging to the unsubscribed Group.

If the operation is successful, the current user receives a roomGroupUnsubscribe event; otherwise the roomGroupUnsubscribeError event is fired.

Unsubscribing also prunes the local Rooms list: the Rooms belonging to the Group are dropped, except the ones currently joined, which survive until they are left.

See also

event::SFSEvent::ROOM_GROUP_UNSUBSCRIBE

event::SFSEvent::ROOM_GROUP_UNSUBSCRIBE_ERROR

SubscribeRoomGroupRequest

Unsubscribes the current user from the Room events of one Group.

After this, the user is no longer notified of the events of the Rooms in that Group.

On success the current user receives a event::SFSEvent::ROOM_GROUP_UNSUBSCRIBE event, otherwise a event::SFSEvent::ROOM_GROUP_UNSUBSCRIBE_ERROR event.

See also

event::SFSEvent::ROOM_GROUP_UNSUBSCRIBE

event::SFSEvent::ROOM_GROUP_UNSUBSCRIBE_ERROR

SubscribeRoomGroupRequest

Constructor & Destructor Documentation

UnsubscribeRoomGroupRequest()

sfs3::requests::UnsubscribeRoomGroupRequest::UnsubscribeRoomGroupRequest ( std::string groupId )

inline

Creates a new UnsubscribeRoomGroupRequest.

Pass it to SmartFox::send for the request to be performed.

Parameters

groupId

The name of the Room Group to unsubscribe.

See also

SmartFox::send

entities::Room::getGroupId

---

The documentation for this class was generated from the following files:

• requests/UnsubscribeRoomGroupRequest.h
• requests/UnsubscribeRoomGroupRequest.cpp