Inherits from NSObject
Declared in RoomSettings.h
RoomSettings.m

Overview

This class provides the Room settings that you can pass to a CreateRoomRequest

Some of these fields are mandatory and some other are populated by default if you don’t specify them.

  • name: mandatory, each Room must have a unique name
  • password: optional, by default a Room is created without a password
  • groupId: optional, by default Rooms are created in the ‘default’ group if none is specified
  • isGame: optional, by default isGame flage is set to false
  • maxUsers: optional, if no value is provided the default value of 10 is used
  • maxSpectators: optional, if no value is provided the default value of 0 is used
  • maxVariables: optional, if no value is provided the default value of 5 is used
  • variables: optional, an array of RoomVariables to be set at creation time
  • permissions: optional, if no value is provided the default RoomPermissions configuration is used
  • events: optional, if no value is provided the default RoomEvents configuration is used
  • extension: optional. No default values

See RoomEvents, RoomPermissions, RoomExtension, CreateRoomRequest

*

Tasks

  •   name

    The name of the new Room

         property
  •   password

    The password of the Room. If null is used the Room will not be password protected

         property
  •   groupId

    the if of the Room Group in which the new Room should be created

         property
  •   isGame

    Indicates if this is a Game Room

         property
  •   maxUsers

    The maximum number of users/players allowed in the Room

         property
  •   maxSpectators

    The maximum number of spectators allowed for this Room (only for Game Rooms)

         property
  •   maxVariables

    The maximum number of Room Variables allowed for this Room

         property
  •   variables

    A list of Room Variables that should be attached to the newly created Room

         property
  •   permissions

    The Room Permission settings of the new Room

         property
  •   events

    The Room Event settings of the new Room

         property
  •   extension

    The Extension settings for the new Room

         property

Properties

events

The Room Event settings of the new Room

@property (retain) RoomEvents *events

Discussion

The Room Event settings of the new Room

See Also

Declared In

RoomSettings.h

extension

The Extension settings for the new Room

@property (retain) RoomExtension *extension

Discussion

The Extension settings for the new Room

See Also

Declared In

RoomSettings.h

groupId

the if of the Room Group in which the new Room should be created

@property (retain) NSString *groupId

Discussion

the if of the Room Group in which the new Room should be created

Declared In

RoomSettings.h

isGame

Indicates if this is a Game Room

@property (assign) BOOL isGame

Discussion

Indicates if this is a Game Room

Declared In

RoomSettings.h

maxSpectators

The maximum number of spectators allowed for this Room (only for Game Rooms)

@property (assign) NSInteger maxSpectators

Discussion

The maximum number of spectators allowed for this Room (only for Game Rooms)

Declared In

RoomSettings.h

maxUsers

The maximum number of users/players allowed in the Room

@property (assign) NSInteger maxUsers

Discussion

The maximum number of users/players allowed in the Room

Declared In

RoomSettings.h

maxVariables

The maximum number of Room Variables allowed for this Room

@property (assign) NSInteger maxVariables

Discussion

The maximum number of Room Variables allowed for this Room

Declared In

RoomSettings.h

name

The name of the new Room

@property (retain) NSString *name

Discussion

The name of the new Room

Declared In

RoomSettings.h

password

The password of the Room. If null is used the Room will not be password protected

@property (retain) NSString *password

Discussion

The password of the Room. If null is used the Room will not be password protected

Declared In

RoomSettings.h

permissions

The Room Permission settings of the new Room

@property (retain) RoomPermissions *permissions

Discussion

The Room Permission settings of the new Room

See Also

Declared In

RoomSettings.h

variables

A list of Room Variables that should be attached to the newly created Room

@property (retain) NSArray *variables

Discussion

A list of Room Variables that should be attached to the newly created Room

See Also

Declared In

RoomSettings.h