cn.leancloud.play.plugin.request

Class JoinRoomRequest

java.lang.Object

cn.leancloud.play.plugin.request.AbstractRequest

cn.leancloud.play.plugin.request.JoinRoomRequest

All Implemented Interfaces:

RoomRequest

public final class JoinRoomRequest
extends AbstractRequest

Constructor Summary

Constructors

Constructor and Description
JoinRoomRequest(Map<clojure.lang.Keyword,Object> requestParams)

Method Summary

Modifier and Type	Method and Description
List<String>	getExpectedUserIds() 获取请求中用于「占位」的玩家 ID 列表。
PlayObject	getMatchProperties() 获取匹配房间条件。传递该参数表示只有待加入房间自定义属性满足匹配条件时才能加入房间
PlayObject	getPlayerCustomRoomProperties() 获取房间玩家自定义属性
boolean	isRejoin() 是否是再次加入房间，即玩家之前在房间中，之后因断线而离开房间，此时再次重加入回原来所在房间
JoinRoomRequest	setExpectUsers(List<String> expectUsers) 设置房间指定的玩家 ID 列表。这个参数主要用于为某些能加入到房间中的特定玩家「占位」。
JoinRoomRequest	setPlayerCustomRoomProperties(PlayObject attr) 设置房间玩家自定义属性
String	toString()

Methods inherited from class cn.leancloud.play.plugin.request.AbstractRequest

equals, getAllInternalParameters, getRoomName, getUserId, hashCode, setReadOnly

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

JoinRoomRequest

public JoinRoomRequest(Map<clojure.lang.Keyword,Object> requestParams)

Method Detail

getExpectedUserIds

public List<String> getExpectedUserIds()

获取请求中用于「占位」的玩家 ID 列表。

Returns:

用于「占位」的玩家 ID 列表

setExpectUsers

public JoinRoomRequest setExpectUsers(List<String> expectUsers)

设置房间指定的玩家 ID 列表。这个参数主要用于为某些能加入到房间中的特定玩家「占位」。

Parameters:

expectUsers - 指定的玩家 ID 列表，列表不能为空，不能是 null。expectUsers 参数会拷贝一份 后存入请求内，所以本方法返回后再修改 expectUsers 不会影响已存入请求内的列表

Returns:

this

isRejoin

public boolean isRejoin()

是否是再次加入房间，即玩家之前在房间中，之后因断线而离开房间，此时再次重加入回原来所在房间

Returns:

是否是再次加入房间

getMatchProperties

public PlayObject getMatchProperties()

获取匹配房间条件。传递该参数表示只有待加入房间自定义属性满足匹配条件时才能加入房间

Returns:

匹配房间条件

getPlayerCustomRoomProperties

public PlayObject getPlayerCustomRoomProperties()

获取房间玩家自定义属性

Returns:

返回房间玩家自定义属性，是不可变 Map

setPlayerCustomRoomProperties

public JoinRoomRequest setPlayerCustomRoomProperties(PlayObject attr)

设置房间玩家自定义属性

Parameters:

attr - 房间玩家自定义属性，不能是空也不能是 null。attr 会被拷贝一份后存入请求内， 所以本方法返回后再修改 attr 不会影响已存入请求内的房间玩家自定义属性参数

Returns:

this

toString

public String toString()

Overrides:

toString in class Object