RoomOptions Class Reference

Public Member Functions
void	SetDataStore (string key, string value)
	Sets the data store for a room. More...
void	ClearDataStore ()
	Clears the data store for a room.
void	SetExcludeRecentlyMet (bool value)
	Sets whether to exclude recently-met users. More...
void	SetMaxUserResults (uint value)
	Sets the maximum number of users to return. More...
void	SetRoomId (UInt64 value)
	Sets a room ID. More...
void	SetRoomName (string roomName)
	Sets a name for the room. More...
void	SetPassword (string password)
	Sets a password for the room. More...
void	SetTurnOffUpdates (bool value)
	Enables/Disables the update of room data. More...
IntPtr	GetHandle ()

Static Public Member Functions
static	operator IntPtr (RoomOptions roomOptions)
	For passing to native C.

Member Function Documentation

SetDataStore()

void SetDataStore ( string  key, string  value  )

inline

Sets the data store for a room.

Parameters

key	A unique identifier that maps to a value.
value	The data.

SetExcludeRecentlyMet()

void SetExcludeRecentlyMet ( bool  value )

inline

Sets whether to exclude recently-met users.

Parameters

value

true: exclude false: not exclude

SetMaxUserResults()

void SetMaxUserResults ( uint  value )

inline

Sets the maximum number of users to return.

Parameters

value

The maximum number of users to return.

SetRoomId()

void SetRoomId ( UInt64  value )

inline

Sets a room ID.

Note

Only available to RoomService.GetInvitableUsers2.

Parameters

value

The room ID.

SetRoomName()

void SetRoomName ( string  roomName )

inline

Sets a name for the room.

Note

Only available to RoomService.JoinOrCreateNamedRoom and RoomService.GetNamedRooms.

Parameters

roomName

The room's name. The maximum length is 64 characters.

SetPassword()

void SetPassword ( string  password )

inline

Sets a password for the room.

Note

Only available to RoomService.JoinOrCreateNamedRoom and RoomService.GetNamedRooms.

Parameters

password

The room's password. The maximum length is 64 characters.

SetTurnOffUpdates()

void SetTurnOffUpdates ( bool  value )

inline

Enables/Disables the update of room data.

Parameters

value

true: enable false: disable