com.electrotank.electroserver4.message.request.JoinRoomRequest

Package	com.electrotank.electroserver4.message.request
Class	public class JoinRoomRequest
Inheritance	JoinRoomRequest com.electrotank.electroserver4.message.request.RequestImpl

This class is used to request joining a room. The CreateRoomRequest class is often used to create or join a room. Many developers don't use this request. When joining a room using this request the minimum information that you need to provide is the roomId and zoneId, and a password if required.

When joining a room there are many things that you can be subscribed to receive events.

Subscription properties when joining a room (all of the following default to true):

setIsReceivingRoomListUpdates(bool) - 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(bool) - If true, you receive UserListUpdateEvent events when the user list in your room changes.
setIsReceivingRoomVariableUpdates(bool) - 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(bool) - 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(bool) - 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(bool) - If true, you receive UpdateRoomDetailsEvent events when room properties such as capacity, description, or the password changes.

	Method	Defined by
		JoinRoomRequest() Creates a new instance of the JoinRoomRequest class.	JoinRoomRequest
		getIsReceivingRoomDetailUpdates():Boolean Returns the isReceivingRoomDetailUpdates property.	JoinRoomRequest
		getIsReceivingRoomListUpdates():Boolean Returns true if the user will receive room list updates.	JoinRoomRequest
		getIsReceivingRoomVariableUpdates():Boolean Returns true if the user is set to receive RoomVariableUpdateEvent events.	JoinRoomRequest
		getIsReceivingUserListUpdates():Boolean Returns true if the user is set up to receive UserListUpdateEvent events for the new room.	JoinRoomRequest
		getIsReceivingUserVariableUpdates():Boolean Returns true if the user is set to receive UserVariableUpdateEvent events in the new room.	JoinRoomRequest
		getIsReceivingVideoEvents():Boolean Returns the isReceivingVideoUpdates property.	JoinRoomRequest
		getPassword():String Returns the password you are using to join the room.	JoinRoomRequest
		getRoom():Room	JoinRoomRequest
		getRoomId():Number Gets the id of the room that you are trying to join.	JoinRoomRequest
		getZoneId():Number Gets the id of the zone that holds the room.	JoinRoomRequest
		setIsReceivingRoomDetailUpdates(isReceiving:Boolean):void The default is true.	JoinRoomRequest
		setIsReceivingRoomListUpdates(receivingRoomListUpdates:Boolean):void The default is true.	JoinRoomRequest
		setIsReceivingRoomVariableUpdates(receivingRoomVariableUpdates:Boolean):void The default is true.	JoinRoomRequest
		setIsReceivingUserListUpdates(receivingUserListUpdates:Boolean):void The default is true.	JoinRoomRequest
		setIsReceivingUserVariableUpdates(receivingUserVariableUpdates:Boolean):void The default is true.	JoinRoomRequest
		setIsReceivingVideoEvents(isReceiving:Boolean):void Default is true.	JoinRoomRequest
		setPassword(pwd:String):void Sets the optional password for the room that you are trying to join.	JoinRoomRequest
		setRoomId(rId:Number):void Sets the id of the room that you are trying to join.	JoinRoomRequest
		setZoneId(zId:Number):void The zone id of the zone the holds the room.	JoinRoomRequest
		validate():ValidationResponse	JoinRoomRequest

Constructor detail

JoinRoomRequest

()

constructor

public function JoinRoomRequest()

Creates a new instance of the JoinRoomRequest class.

Method detail

getIsReceivingRoomDetailUpdates

()

method

public function getIsReceivingRoomDetailUpdates():Boolean

Returns the isReceivingRoomDetailUpdates property.

Returns

Boolean — Returns the isReceivingRoomDetailUpdates property.

getIsReceivingRoomListUpdates

()

method

public function getIsReceivingRoomListUpdates():Boolean

Returns true if the user will receive room list updates.

Returns

Boolean — Returns true if the user will receive room list updates.

getIsReceivingRoomVariableUpdates

()

method

public function getIsReceivingRoomVariableUpdates():Boolean

Returns true if the user is set to receive RoomVariableUpdateEvent events.

Returns

Boolean — Returns true if the user is set to receive RoomVariableUpdateEvent events.

getIsReceivingUserListUpdates

()

method

public function getIsReceivingUserListUpdates():Boolean

Returns true if the user is set up to receive UserListUpdateEvent events for the new room.

Returns

Boolean — Returns true if the user is set up to receive UserListUpdateEvent events for the new room.

getIsReceivingUserVariableUpdates

()

method

public function getIsReceivingUserVariableUpdates():Boolean

Returns true if the user is set to receive UserVariableUpdateEvent events in the new room.

Returns

Boolean — Returns true if the user is set to receive UserVariableUpdateEvent events in the new room.

getIsReceivingVideoEvents

()

method

public function getIsReceivingVideoEvents():Boolean

Returns the isReceivingVideoUpdates property.

Returns

Boolean — Returns the isReceivingVideoUpdates property.

getPassword

()

method

public function getPassword():String

Returns the password you are using to join the room.

Returns

String — Returns the password you are using to join the room.

getRoom

()

method

public function getRoom():Room

Returns

Room

getRoomId

()

method

public function getRoomId():Number

Gets the id of the room that you are trying to join.

Returns

Number — Retunrs the id of the room that youa re trying to join.

getZoneId

()

method

public function getZoneId():Number

Gets the id of the zone that holds the room.

Returns

Number — Returns the id of the zone that holds the room.

setIsReceivingRoomDetailUpdates

()

method

public function setIsReceivingRoomDetailUpdates(isReceiving:Boolean):void

The 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.

Parameters

isReceiving:Boolean — Set to true if you want to receive these updates.

setIsReceivingRoomListUpdates

()

method

public function setIsReceivingRoomListUpdates(receivingRoomListUpdates:Boolean):void

The 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.

Parameters

receivingRoomListUpdates:Boolean — Pass in true to receive room list updates with the ZoneUpdateEvent.

setIsReceivingRoomVariableUpdates

()

method

public function setIsReceivingRoomVariableUpdates(receivingRoomVariableUpdates:Boolean):void

The 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.

Parameters

receivingRoomVariableUpdates:Boolean — Pass in true to receive RoomVariableUpdateEvent events.

setIsReceivingUserListUpdates

()

method

public function setIsReceivingUserListUpdates(receivingUserListUpdates:Boolean):void

The 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.

Parameters

receivingUserListUpdates:Boolean — Pass in true to receive UserListUpdateEvent events for this new room.

setIsReceivingUserVariableUpdates

()

method

public function setIsReceivingUserVariableUpdates(receivingUserVariableUpdates:Boolean):void

The 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.

Parameters

receivingUserVariableUpdates:Boolean — Pass in true to receive UserVariableUpdateEvent events for the newly created room.

setIsReceivingVideoEvents

()

method

public function setIsReceivingVideoEvents(isReceiving:Boolean):void

Default is true. If true, you will receive UserListUpdateEvent events when users in your room start or stop publishing live streams to the server.

Parameters

isReceiving:Boolean — Set to true if you want to receive these events.

setPassword

()

method

public function setPassword(pwd:String):void

Sets the optional password for the room that you are trying to join.

Parameters

pwd:String — The password needed to joint the room.

setRoomId

()

method

public function setRoomId(rId:Number):void

Sets the id of the room that you are trying to join.

Parameters

rId:Number — The id of the room that you are trying to join.

setZoneId

()

method

public function setZoneId(zId:Number):void

The zone id of the zone the holds the room.

Parameters

zId:Number — The id of the zone that holds the room.

validate

()

method

public override function validate():ValidationResponse

Returns

ValidationResponse

ElectroServer 4 ActionScript 3 Documentation	All Packages \| All Classes \| Index \| Frames No Frames
Class JoinRoomRequest	Methods