SFS2X Objective-C API  1.7.13
iOS / macOS / tvOS
RoomEvents Class Reference

#import <RoomEvents.h>

Inherits NSObject.

Protected Attributes

BOOL _allowUserEnter
 
BOOL _allowUserExit
 
BOOL _allowUserCountChange
 
BOOL _allowUserVariablesUpdate
 

Properties

BOOL allowUserEnter
 
BOOL allowUserExit
 
BOOL allowUserCountChange
 
BOOL allowUserVariablesUpdate
 

Detailed Description

This class provides Room event settings that can be specified when creating a new Room via the CreateRoomRequest

You can configure which events the Room will fire in the Zone:

  • allowUserEnter: fire an event each time a User enters/joins the Room
  • allowUserExit: fire an event each time a User exits/leaves the Room
  • allowUserCountChange: fire an event each time the user count/spectator count changes in the Room
  • allowUserVariablesUpdate: fire an event each time a user in the Room has updated his/her UserVariables

Each of these events can be turned ON (true) or OFF (false)

See also
CreateRoomSettings
CreateRoomRequest

Property Documentation

◆ allowUserCountChange

- (BOOL) allowUserCountChange
readwriteatomicassign

fire an event each time the user count/spectator count changes in the Room

◆ allowUserEnter

- (BOOL) allowUserEnter
readwriteatomicassign

fire an event each time a User enters/joins the Room

◆ allowUserExit

- (BOOL) allowUserExit
readwriteatomicassign

fire an event each time a User exits/leaves the Room

◆ allowUserVariablesUpdate

- (BOOL) allowUserVariablesUpdate
readwriteatomicassign

fire an event each time a user in the Room has updated his/her UserVariables