| Package | com.electrotank.electroserver4.message.request |
| Class | public class CreateRoomRequest |
| Inheritance | CreateRoomRequest  com.electrotank.electroserver4.message.request.RequestImpl |
setIsReceivingRoomListUpdates(boolean) - If true, you receive ZoneUpdateEvent events when rooms are added to or removed from this zone, or when the the total count of users in one of those rooms changes.
setIsReceivingUserListUpdates(boolean) - If true, you receive UserListUpdateEvent events when the user list in your room changes.
setIsReceivingRoomVariableUpdates(boolean) - If true, you receive the initial room variable list for your room and RoomVariableUpdateEvent events when room variables in your room are created, removed, or modified.
setIsReceivingUserVariableUpdates(boolean) - If true, you receive the initial user variable list for new users joinin your room as well as UserVariableUpdateEvent events when new user variables are created, removed, or modified on a user.
setIsReceivingVideoEvents(boolean) - If true, you receive UserListUpdateEvent event when users in the room start or stop streaming live video to the server. The stream name is part of that event.
setIsReceivingRoomDetailUpdates(boolean) - If true, you receive UpdateRoomDetailsEvent events when room properties such as capacity, description, or the password changes.
//Import the needed classes
import com.electrotank.electroserver4.ElectroServer;
import com.electrotank.electroserver4.message.MessageType;
import com.electrotank.electroserver4.message.request.CreateRoomRequest;
import com.electrotank.electroserver4.message.event.JoinRoomEvent;
import com.electrotank.electroserver4.user.User;
//
//create the request
var crr:CreateRoomRequest = new CreateRoomRequest();
crr.setRoomName("Some Room");
crr.setZoneName("Some Zone");
//
//Send the request
es.send(crr);
//
//Configure the JoinRoomEvent so you know when you've been joined.
es.addEventListener(MessageType.JoinRoomEvent, "onJoinRoomEvent", this);
function onJoinRoomEvent(e:JoinRoomEvent):void {
var roomId:Number = e.getRoomId();
var zoneId:Number = e.getZoneId();
//trace the users in your room
for (var i:int=0;i>e.getUsers().length;++i) {
var u:User = e.getUsers()[i];
trace(u.getUserName());
}
}
import com.electrotank.electroserver4.ElectroServer;
import com.electrotank.electroserver4.entities.RoomVariable;
import com.electrotank.electroserver4.esobject.EsObject;
import com.electrotank.electroserver4.message.request.CreateRoomRequest;
import com.electrotank.electroserver4.message.MessageType;
import com.electrotank.electroserver4.plugin.Plugin;
var es:ElectroServer;
es.addEventListener(MessageType.JoinRoomEvent, "onJoinRoomEvent", this);
function createRoom():void {
var crr:CreateRoomRequest = new CreateRoomRequest();
crr.setRoomName("Some room");
crr.setZoneName("Some zone");
//Set a few properties
crr.setCapacity(10);
crr.setRoomDescription("This is a my room");
crr.setPassword("secret");
//create two room variables
//room var 1
var ob1:EsObject = new EsObject();
ob1.setString("Test_String", "blah");
ob1.setInteger("Test_int", 3);
var rv1:RoomVariable = new RoomVariable("test1", ob1, true, false);
//room var 2
var ob2:EsObject = new EsObject();
ob1.setString("Test_String2", "blah2");
ob1.setInteger("Test_int2", 12);
var rv2:RoomVariable = new RoomVariable("test2", ob2, false, false);
//add the room variables to the request
crr.setRoomVariables([rv1, rv2]);
//Create a new plugin for this room
var pl:Plugin = new Plugin();
pl.setExtensionName("ExamplePluginExtension");
pl.setPluginHandle("ExamplePlugin");
pl.setPluginName("ExamplePlugin");
//add the plugin to the request
crr.setPlugins([pl]);
//Now configure some of the user's subscription properties
crr.setIsReceivingRoomDetailUpdates(false);//Don't want to receive updates about other rooms
crr.setIsReceivingRoomListUpdates(false);//Don't want to receive updates about when other rooms are created or destroyed
crr.setIsReceivingUserListUpdates(true);//true is the default. When true you will receive user list updates for your room.
//
//Now send the request to the server
es.send(crr);
}
function onJoinRoomEvent(e:JoinRoomEvent):void {
var roomId:Number = e.getRoomId();
var zoneId:Number = e.getZoneId();
//trace the users in your room
for (var i:int=0;i>e.getUsers().length;++i) {
var u:User = e.getUsers()[i];
trace(u.getUserName());
}
}
| Method | Defined by | ||
|---|---|---|---|
|
Creates a new instance of the CreateRoomRequest object.
| CreateRoomRequest | ||
|
getBanDuration():Number
Returns the amount of time in seconds that a user will be banned if banned due to language fitler violation.
| CreateRoomRequest | ||
|
getCapacity():Number
Returns the maximum number of users allowed in this room at once.
| CreateRoomRequest | ||
|
getFailuresBeforeKick():Number
Returns the number of language filter failures before the user is kicked.
| CreateRoomRequest | ||
|
getFloodingFilterBanDuration():Number
Returns the amount of time in seconds that a user will be banned if ban due to flooding.
| CreateRoomRequest | ||
|
getFloodingFilterFailuresBeforeKick():Number
Returns the number of flooding failures allowed before the user is kicked.
| CreateRoomRequest | ||
|
getFloodingFilterKicksBeforeBan():Number
Returns the amount of times a user can be kicked due to flooding before being banned.
| CreateRoomRequest | ||
|
getFloodingFilterName():String
Returns the name of the custom flooding filter.
| CreateRoomRequest | ||
|
getIsDeliverMessageOnFailure():Boolean
Returns true if a message is supposed to be delivered even if it fails language filter validation.
| CreateRoomRequest | ||
|
getIsFloodingFilterResetAfterKick():Boolean
If a custom flooding filter was specified by name then this property is used by the room.
| CreateRoomRequest | ||
|
getIsFloodingFilterSpecified():Boolean
Returns true if a custom flooding filter name has been specified.
| CreateRoomRequest | ||
|
getIsHidden():Boolean
Returns false if the room is set to be hidden on create.
| CreateRoomRequest | ||
|
getIsLanguageFilterSpecified():Boolean
If a custom language filter was specified by name using setLanguageFilterName, then this method returns true.
| CreateRoomRequest | ||
|
getIsNonOperatorUpdateAllowed():Boolean
| CreateRoomRequest | ||
|
getIsNonOperatorVariableUpdateAllowed():Boolean
| CreateRoomRequest | ||
|
getIsPersistent():Boolean
Returns false if the room is set to automatically be removed when the user list is 0.
| CreateRoomRequest | ||
|
getIsReceivingRoomDetailUpdates():Boolean
Returns the isReceivingRoomDetailUpdates property.
| CreateRoomRequest | ||
|
getIsReceivingRoomListUpdates():Boolean
Returns true if the user will receive room list updates.
| CreateRoomRequest | ||
|
getIsReceivingRoomVariableUpdates():Boolean
Returns true if the user is set to receive RoomVariableUpdateEvent events.
| CreateRoomRequest | ||
|
getIsReceivingUserListUpdates():Boolean
Returns true if the user is set up to receive UserListUpdateEvent events for the new room.
| CreateRoomRequest | ||
|
getIsReceivingUserVariableUpdates():Boolean
Returns true if the user is set to receive UserVariableUpdateEvent events in the new room.
| CreateRoomRequest | ||
|
getIsReceivingVideoEvents():Boolean
Returns the isReceivingVideoUpdates property.
| CreateRoomRequest | ||
|
getIsResetAfterKick():Boolean
Returns true if the number of language filter failures is to be reset after a user is kicked.
| CreateRoomRequest | ||
|
getIsUsingFloodingFilter():Boolean
Returns true if flood filtering has been enabled for this room.
| CreateRoomRequest | ||
|
getIsUsingLanguageFilter():Boolean
Returns true if language filtering is enabled.
| CreateRoomRequest | ||
|
getKicksBeforeBan():Number
Returns the number of times a user can be kicked before getting banned.
| CreateRoomRequest | ||
|
getLanguageFilterName():String
The name of the custom language filter used in this room, if any.
| CreateRoomRequest | ||
|
getPassword():String
Returns the optional password used to protect the room.
| CreateRoomRequest | ||
|
getPlugins():Array
Returns the array of Plugin objects that represent plugins to be created in this new room.
| CreateRoomRequest | ||
|
getRoomDescription():String
Returns the optional string description of the room.
| CreateRoomRequest | ||
|
getRoomName():String
Returns the name of the room to be created.
| CreateRoomRequest | ||
|
getRoomVariables():Array
Returns an array of RoomVariable objecs that represent room variables to be created in the new room.
| CreateRoomRequest | ||
|
getZoneId():Number
Returns the id of the zone in which to create the room.
| CreateRoomRequest | ||
|
getZoneName():String
Returns the name of the zone in which the room will be created.
| CreateRoomRequest | ||
|
setBanDuration(duration:Number):void
This is used with a custom language filter.
| CreateRoomRequest | ||
|
setCapacity(capacity:Number):void
A room can be given a hard cap of the maximum number of users allowed in it at once.
| CreateRoomRequest | ||
|
setFailuresBeforeKick(failuresBeforeKick:Number):void
This is used only with a custom language filter.
| CreateRoomRequest | ||
|
setFloodingFilterBanDuration(banDuration:Number):void
This property is used if a custom flooding filter has been specified.
| CreateRoomRequest | ||
|
setFloodingFilterFailuresBeforeKick(failuresBeforeKick:Number):void
This property is used if a custom flooding filter has been specified.
| CreateRoomRequest | ||
|
setFloodingFilterKicksBeforeBan(kicksBeforeBan:Number):void
This property is used if a custom flooding filter has been specified.
| CreateRoomRequest | ||
|
setFloodingFilterName(filterName:String):void
The name of the custom flooding filter to use.
| CreateRoomRequest | ||
|
setIsDeliverMessageOnFailure(val:Boolean):void
This is used only if a custom language filter is being used.
| CreateRoomRequest | ||
|
setIsFloodingFilterResetAfterKick(isResetAfterKick:Boolean):void
If using a custom flooding filter then this property is used.
| CreateRoomRequest | ||
|
setIsHidden(hidden:Boolean):void
The default is false.
| CreateRoomRequest | ||
|
setIsNonOperatorUpdateAllowed(val:Boolean):void
| CreateRoomRequest | ||
|
setIsNonOperatorVariableUpdateAllowed(val:Boolean):void
| CreateRoomRequest | ||
|
setIsPersistent(persistent:Boolean):void
The default is false.
| CreateRoomRequest | ||
|
setIsReceivingRoomDetailUpdates(isReceiving:Boolean):void
The default is true.
| CreateRoomRequest | ||
|
setIsReceivingRoomListUpdates(receivingRoomListUpdates:Boolean):void
The default is true.
| CreateRoomRequest | ||
|
setIsReceivingRoomVariableUpdates(receivingRoomVariableUpdates:Boolean):void
The default is true.
| CreateRoomRequest | ||
|
setIsReceivingUserListUpdates(receivingUserListUpdates:Boolean):void
The default is true.
| CreateRoomRequest | ||
|
setIsReceivingUserVariableUpdates(receivingUserVariableUpdates:Boolean):void
The default is true.
| CreateRoomRequest | ||
|
setIsReceivingVideoEvents(isReceiving:Boolean):void
Default is true.
| CreateRoomRequest | ||
|
setIsResetAfterKick(resetAfterKick:Boolean):void
This is used if a custom language filter has been specified.
| CreateRoomRequest | ||
|
setIsUsingFloodingFilter(useFloodingFilter:Boolean):void
The default if false.
| CreateRoomRequest | ||
|
setIsUsingLanguageFilter(useLanguageFilter:Boolean):void
The default is false.
| CreateRoomRequest | ||
|
setKicksBeforeBan(kicksBeforeBan:Number):void
This is used with a custom language filter.
| CreateRoomRequest | ||
|
setLanguageFilterName(filterName:String):void
Custom language filters can be defined and given a name through the web-based administrator.
| CreateRoomRequest | ||
|
setPassword(password:String):void
This is optional.
| CreateRoomRequest | ||
|
setPlugins(plugins:Array):void
Sets an array of Plugin objects that represent the plugins that need to be created with this room.
| CreateRoomRequest | ||
|
setRoomDescription(description:String):void
This is an optional public room-level property.
| CreateRoomRequest | ||
|
setRoomName(name:String):void
Sets the name of the new room.
| CreateRoomRequest | ||
|
setRoomVariables(roomVariables:Array):void
Sets an array of RoomVariable objects to be used in the new room that is being created.
| CreateRoomRequest | ||
|
setZoneId(id:Number):void
Sets the id of the zone in which you want to create the room.
| CreateRoomRequest | ||
|
setZoneName(name:String):void
Sets the name of the zone in which to create the new room.
| CreateRoomRequest | ||
| CreateRoomRequest | |||
| CreateRoomRequest | () | constructor |
public function CreateRoomRequest()Creates a new instance of the CreateRoomRequest object.
| getBanDuration | () | method |
public function getBanDuration():NumberReturns the amount of time in seconds that a user will be banned if banned due to language fitler violation.
ReturnsNumber — Returns the amount of time in seconds that a user will be banned if banned due to language fitler violation.
|
| getCapacity | () | method |
public function getCapacity():NumberReturns the maximum number of users allowed in this room at once.
ReturnsNumber — Returns the maximum number of users allowed in this room at once.
|
| getFailuresBeforeKick | () | method |
public function getFailuresBeforeKick():NumberReturns the number of language filter failures before the user is kicked.
ReturnsNumber — Returns the number of language filter failures before the user is kicked.
|
| getFloodingFilterBanDuration | () | method |
public function getFloodingFilterBanDuration():NumberReturns the amount of time in seconds that a user will be banned if ban due to flooding.
ReturnsNumber — The amount of time in seconds of the ban.
|
| getFloodingFilterFailuresBeforeKick | () | method |
public function getFloodingFilterFailuresBeforeKick():NumberReturns the number of flooding failures allowed before the user is kicked.
ReturnsNumber — The number of flooding failures before the user is kicked.
|
| getFloodingFilterKicksBeforeBan | () | method |
public function getFloodingFilterKicksBeforeBan():NumberReturns the amount of times a user can be kicked due to flooding before being banned.
ReturnsNumber — The number of times the user can be kicked before getting banned.
|
| getFloodingFilterName | () | method |
public function getFloodingFilterName():StringReturns the name of the custom flooding filter.
ReturnsString — Returns the name of the custom flooding filter.
|
| getIsDeliverMessageOnFailure | () | method |
public function getIsDeliverMessageOnFailure():BooleanReturns true if a message is supposed to be delivered even if it fails language filter validation.
ReturnsBoolean — Returns true if a message is supposed to be delivered even if it fails language filter validation.
|
| getIsFloodingFilterResetAfterKick | () | method |
public function getIsFloodingFilterResetAfterKick():BooleanIf a custom flooding filter was specified by name then this property is used by the room. The default is false.
ReturnsBoolean — True or false
|
| getIsFloodingFilterSpecified | () | method |
public function getIsFloodingFilterSpecified():BooleanReturns true if a custom flooding filter name has been specified.
ReturnsBoolean — Returns true if a custom flooding filter name has been specified.
|
| getIsHidden | () | method |
public function getIsHidden():BooleanReturns false if the room is set to be hidden on create. A hidden room does not show up in the room list.
ReturnsBoolean — Returns false if the room is set to be hidden on create. A hidden room does not show up in the room list.
|
| getIsLanguageFilterSpecified | () | method |
public function getIsLanguageFilterSpecified():BooleanIf a custom language filter was specified by name using setLanguageFilterName, then this method returns true. Otherwise it returns false.
ReturnsBoolean — Returns true if a custom language filter was specified to be used by name.
|
| getIsNonOperatorUpdateAllowed | () | method |
public function getIsNonOperatorUpdateAllowed():Boolean
Returns
Boolean |
| getIsNonOperatorVariableUpdateAllowed | () | method |
public function getIsNonOperatorVariableUpdateAllowed():Boolean
Returns
Boolean |
| getIsPersistent | () | method |
public function getIsPersistent():BooleanReturns false if the room is set to automatically be removed when the user list is 0. Returns true when it is set to never die.
ReturnsBoolean — Returns false if the room is set to automatically be removed when the user list is 0. Returns true when it is set to never die.
|
| getIsReceivingRoomDetailUpdates | () | method |
public function getIsReceivingRoomDetailUpdates():BooleanReturns the isReceivingRoomDetailUpdates property.
ReturnsBoolean — Returns the isReceivingRoomDetailUpdates property.
|
| getIsReceivingRoomListUpdates | () | method |
public function getIsReceivingRoomListUpdates():BooleanReturns true if the user will receive room list updates.
ReturnsBoolean — Returns true if the user will receive room list updates.
|
| getIsReceivingRoomVariableUpdates | () | method |
public function getIsReceivingRoomVariableUpdates():BooleanReturns true if the user is set to receive RoomVariableUpdateEvent events.
ReturnsBoolean — Returns true if the user is set to receive RoomVariableUpdateEvent events.
|
| getIsReceivingUserListUpdates | () | method |
public function getIsReceivingUserListUpdates():BooleanReturns true if the user is set up to receive UserListUpdateEvent events for the new room.
ReturnsBoolean — Returns true if the user is set up to receive UserListUpdateEvent events for the new room.
|
| getIsReceivingUserVariableUpdates | () | method |
public function getIsReceivingUserVariableUpdates():BooleanReturns true if the user is set to receive UserVariableUpdateEvent events in the new room.
ReturnsBoolean — Returns true if the user is set to receive UserVariableUpdateEvent events in the new room.
|
| getIsReceivingVideoEvents | () | method |
public function getIsReceivingVideoEvents():BooleanReturns the isReceivingVideoUpdates property.
ReturnsBoolean — Returns the isReceivingVideoUpdates property.
|
| getIsResetAfterKick | () | method |
public function getIsResetAfterKick():BooleanReturns true if the number of language filter failures is to be reset after a user is kicked.
ReturnsBoolean — Returns true if the number of language filter failures is to be reset after a user is kicked.
|
| getIsUsingFloodingFilter | () | method |
public function getIsUsingFloodingFilter():BooleanReturns true if flood filtering has been enabled for this room.
ReturnsBoolean — Returns true if flood filtering has been enabled for this room.
|
| getIsUsingLanguageFilter | () | method |
public function getIsUsingLanguageFilter():BooleanReturns true if language filtering is enabled.
ReturnsBoolean — Returns true if language filtering is enabled.
|
| getKicksBeforeBan | () | method |
public function getKicksBeforeBan():NumberReturns the number of times a user can be kicked before getting banned.
ReturnsNumber — Returns the number of times a user can be kicked before getting banned.
|
| getLanguageFilterName | () | method |
public function getLanguageFilterName():StringThe name of the custom language filter used in this room, if any.
ReturnsString — The name of the custom language filter used in this room, if any.
|
| getPassword | () | method |
public function getPassword():StringReturns the optional password used to protect the room.
ReturnsString — Returns the optional password used to protect the room.
|
| getPlugins | () | method |
public function getPlugins():ArrayReturns the array of Plugin objects that represent plugins to be created in this new room.
ReturnsArray — Returns the array of Plugin objects that represent plugins to be created in this new room.
|
| getRoomDescription | () | method |
public function getRoomDescription():StringReturns the optional string description of the room.
ReturnsString — Returns the optional string description of the room.
|
| getRoomName | () | method |
public function getRoomName():StringReturns the name of the room to be created.
ReturnsString — Returns the name of the room to be created.
|
| getRoomVariables | () | method |
public function getRoomVariables():ArrayReturns an array of RoomVariable objecs that represent room variables to be created in the new room.
ReturnsArray — Returns an array of RoomVariable objecs that represent room variables to be created in the new room.
|
| getZoneId | () | method |
public function getZoneId():NumberReturns the id of the zone in which to create the room. If none has been specified then -1 is returned.
ReturnsNumber |
| getZoneName | () | method |
public function getZoneName():StringReturns the name of the zone in which the room will be created.
ReturnsString — Returns the name of the zone in which the room will be created.
|
| setBanDuration | () | method |
public function setBanDuration(duration:Number):voidThis is used with a custom language filter. The default is -1, which is indefinate. If a user is kicked the number of times specified with the setKicksBeforeBan method, then the user is banned from the server. The amount of time (in seconds) a user should be banned for is set with this method.
Parametersduration:Number — The amount of time in seconds to ban the user that abused the language filter.
|
| setCapacity | () | method |
public function setCapacity(capacity:Number):voidA room can be given a hard cap of the maximum number of users allowed in it at once. This method is used to do that. The default is -1, which means that there is no limit.
Parameterscapacity:Number — The maximum number of users allowed in the room at once.
|
| setFailuresBeforeKick | () | method |
public function setFailuresBeforeKick(failuresBeforeKick:Number):voidThis is used only with a custom language filter. The default is 3. Use this method to set the number of times a language filter failure is allowed before the user is kicked from the room.
ParametersfailuresBeforeKick:Number — The number of times a user can send a message that fails language filter validation before being kicked.
|
| setFloodingFilterBanDuration | () | method |
public function setFloodingFilterBanDuration(banDuration:Number):voidThis property is used if a custom flooding filter has been specified. The default is -1, which is an indefinate ban (until server reboot). The ban duration can be set with this method. The value is in seconds. A banned user cannot log back in.
ParametersbanDuration:Number — Time in seconds of the ban. Use -1 to ban indefinately (or until server reboot).
|
| setFloodingFilterFailuresBeforeKick | () | method |
public function setFloodingFilterFailuresBeforeKick(failuresBeforeKick:Number):voidThis property is used if a custom flooding filter has been specified. The default is 1. When flooding has been detected it counts as 1 failure. When a user has caused the number of failures specified by this property that user is then kicked from the room.
ParametersfailuresBeforeKick:Number — The number of flooding failures before the user is kicked.
|
| setFloodingFilterKicksBeforeBan | () | method |
public function setFloodingFilterKicksBeforeBan(kicksBeforeBan:Number):voidThis property is used if a custom flooding filter has been specified. The default is 3. The amount of times a user is kicked due to the flooding filter is tracked. When the user reaches the number specified here that user is banned. The duration of that ban is set with setFloodingFilterBanDuration.
ParameterskicksBeforeBan:Number — The number of times to kick
|
| setFloodingFilterName | () | method |
public function setFloodingFilterName(filterName:String):voidThe name of the custom flooding filter to use. The custom flooding filter is defined via the web-based administrator and given a name. That name is used here. In order to use a custom flooding filter in a room you must use this method and also use setIsUsingFloodingFilter to enabled flooding filters for the room.
ParametersfilterName:String — The name of the custom flooding filter.
|
| setIsDeliverMessageOnFailure | () | method |
public function setIsDeliverMessageOnFailure(val:Boolean):voidThis is used only if a custom language filter is being used. The default is false. If true, then a message that fails language filter validation is still deliverd to the room.
Parametersval:Boolean — Pass in true if you want a failed message to still be delivered.
|
| setIsFloodingFilterResetAfterKick | () | method |
public function setIsFloodingFilterResetAfterKick(isResetAfterKick:Boolean):voidIf using a custom flooding filter then this property is used. The default is false. The user is kicked after a number of flood failures has been reached. That number is reset after kick if this property is set to true. You can configure the number of failures before kick with setFloodingFilterFailuresBeforeKick.
ParametersisResetAfterKick:Boolean — Set to true to erase the number of flooding failures detected on kick.
|
| setIsHidden | () | method |
public function setIsHidden(hidden:Boolean):voidThe default is false. If set to true, then the room will not show up in the room list for the zone in which the room was created. Users can still join the room if they know the room and zone names. The hidden property of a room can be changed later using the UpdateRoomDetailsRequest.
Parametershidden:Boolean — Pass in true if you want the room to not show up in the room list.
|
| setIsNonOperatorUpdateAllowed | () | method |
public function setIsNonOperatorUpdateAllowed(val:Boolean):voidParameters
val:Boolean |
| setIsNonOperatorVariableUpdateAllowed | () | method |
public function setIsNonOperatorVariableUpdateAllowed(val:Boolean):voidParameters
val:Boolean |
| setIsPersistent | () | method |
public function setIsPersistent(persistent:Boolean):voidThe default is false. When false, a room will automatically be removed from the server when there are no more users in it. When set to true, the room will not be removed when empty. Persistent rooms should be used wisely since that can cause a memory leak by leaving dangling rooms.
Parameterspersistent:Boolean — Pass in true to keep a room around even if empty, false if you want it to get cleaned up when empty.
|
| setIsReceivingRoomDetailUpdates | () | method |
public function setIsReceivingRoomDetailUpdates(isReceiving:Boolean):voidThe default is true. If true, you will receive UpdateRoomDetailsEvent events for all rooms in your zone. That includes description, capacity, password status, and room name.
ParametersisReceiving:Boolean — Set to true if you want to receive these updates.
|
| setIsReceivingRoomListUpdates | () | method |
public function setIsReceivingRoomListUpdates(receivingRoomListUpdates:Boolean):voidThe default is true. This is a user-level property used when joining a room. You will find this property in the JoinRoomRequest as well. If true, the user will receive add/remove updaes to the room list for the current zone. This is part of the ZoneUpdateEvent.
ParametersreceivingRoomListUpdates:Boolean — Pass in true to receive room list updates with the ZoneUpdateEvent.
|
| setIsReceivingRoomVariableUpdates | () | method |
public function setIsReceivingRoomVariableUpdates(receivingRoomVariableUpdates:Boolean):voidThe default is true. This is a user-level property used when joining a room. You will find this property in the JoinRoomRequest as well. If true, the user will receive RoomVariableUpdateEvent events for the newly created room.
ParametersreceivingRoomVariableUpdates:Boolean — Pass in true to receive RoomVariableUpdateEvent events.
|
| setIsReceivingUserListUpdates | () | method |
public function setIsReceivingUserListUpdates(receivingUserListUpdates:Boolean):voidThe default is true. This is a user-level property used when joining a room. You will find this property in the JoinRoomRequest as well. If true, the user will receive updates to the user list for this room through the UserListUpdateEvent.
ParametersreceivingUserListUpdates:Boolean — Pass in true to receive UserListUpdateEvent events for this new room.
|
| setIsReceivingUserVariableUpdates | () | method |
public function setIsReceivingUserVariableUpdates(receivingUserVariableUpdates:Boolean):voidThe default is true. This is a user-level property used when joining a room. You will find this property in the JoinRoomRequest as well. If true, the user will receive UserVariableUpdateEvent events.
ParametersreceivingUserVariableUpdates:Boolean — Pass in true to receive UserVariableUpdateEvent events for the newly created room.
|
| setIsReceivingVideoEvents | () | method |
public function setIsReceivingVideoEvents(isReceiving:Boolean):voidDefault is true. If true, you will receive UserListUpdateEvent events when users in your room start or stop publishing live streams to the server.
ParametersisReceiving:Boolean — Set to true if you want to receive these events.
|
| setIsResetAfterKick | () | method |
public function setIsResetAfterKick(resetAfterKick:Boolean):voidThis is used if a custom language filter has been specified. When a language filter failure occurs it is stored and associated with that user. When the amount specified by the setFailuresBeforeKick method is reached the user is kicked from the room. If this property is true then that number is reset to 0 when the user comes back in the room. If false, then that number is not reset.
ParametersresetAfterKick:Boolean — Pass in true to resent the number of language filter failures associated with a user after they are kicked.
|
| setIsUsingFloodingFilter | () | method |
public function setIsUsingFloodingFilter(useFloodingFilter:Boolean):voidThe default if false. If set to true then flood filtering is enabled for the room using the server-defined default flooding filter. You can view and edit the properties of the default flooding filter through the web-based administrator. If you want to specify a custom flooding filter then use the setFloodingFilterName method.
ParametersuseFloodingFilter:Boolean — Pass in true if you want to flood filtering enabled in this room.
|
| setIsUsingLanguageFilter | () | method |
public function setIsUsingLanguageFilter(useLanguageFilter:Boolean):voidThe default is false. Use this method to enable language filtering for this room. If you enable language filtering and do nothing else, then the default language filter is used. That is defined in the web-based administrator. You can also create custom language filters through the web-based administrator and use them in a room. To use a custom language filter, assign it using the setLanguageFilterName method. When a message fails language filter validation several actions can be taken. The default actions (for the default filter) are defined on the server. If you specify a custom filter then the actions are configurable here. The configuration allows you to control the delivery of a failed message and the punishment given to the user (kick, ban, nothing).
ParametersuseLanguageFilter:Boolean — Pass in true to enable language filtering.
|
| setKicksBeforeBan | () | method |
public function setKicksBeforeBan(kicksBeforeBan:Number):voidThis is used with a custom language filter. The default is 3. This sets the number of times a user can be kicked due to language filter violations before that user is banned.
ParameterskicksBeforeBan:Number — The number of times a user can be kicked before getting banned.
|
| setLanguageFilterName | () | method |
public function setLanguageFilterName(filterName:String):voidCustom language filters can be defined and given a name through the web-based administrator. This method allows you to use one in this room. In addition to this method you must also use the setIsUsingLanguageFilter method to enable language filtering in this room.
ParametersfilterName:String — The name of the custom language filter to use.
|
| setPassword | () | method |
public function setPassword(password:String):voidThis is optional. The room can be password protected. To do that, set a password using this method. Users that attempt to join this room will need to use the password.
Parameterspassword:String — The optional password used to protect the room.
|
| setPlugins | () | method |
public function setPlugins(plugins:Array):voidSets an array of Plugin objects that represent the plugins that need to be created with this room.
Parametersplugins:Array — arr
|
| setRoomDescription | () | method |
public function setRoomDescription(description:String):voidThis is an optional public room-level property. By setting a string value here anyone that can see this room in a room list will see the description property.
Parametersdescription:String — The optional string description of the room.
|
| setRoomName | () | method |
public function setRoomName(name:String):voidSets the name of the new room. If a room of this name already exists in the specified zone, then you will be joined to that room. If you are joined to an existing room then none of the room-level properties specified here will be used. However, all of the user-subscription properies will be used.
Parametersname:String — The name of the room to be created.
|
| setRoomVariables | () | method |
public function setRoomVariables(roomVariables:Array):voidSets an array of RoomVariable objects to be used in the new room that is being created.
ParametersroomVariables:Array — roomVariables
|
| setZoneId | () | method |
public function setZoneId(id:Number):voidSets the id of the zone in which you want to create the room. A zone must be specified, but it is usually done by name using the setZoneName method. The setZoneId method is rarely used.
Parametersid:Number — The id of the zone in which to create the room.
|
| setZoneName | () | method |
public function setZoneName(name:String):voidSets the name of the zone in which to create the new room. If a zone of that name doesn't exist, then it will be created. Either a zone name or a zone id must be specified. Usually it is the zone name.
Parametersname:String — The name of the zone in which to create the room.
|
| validate | () | method |