cn.leancloud.play.plugin.request

Class SetPlayerPropertiesRequest

java.lang.Object

cn.leancloud.play.plugin.request.AbstractRequest

cn.leancloud.play.plugin.request.SetPlayerPropertiesRequest

All Implemented Interfaces:

RoomRequest

public final class SetPlayerPropertiesRequest
extends AbstractRequest

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
PlayObject	getExpectedValues() 获取 CAS 操作用于匹配的玩家自定义属性。设置了用于匹配的自定义属性后，只有当玩家在房间内属性符合 匹配的值后更新玩家属性操作才会生效。
PlayObject	getProperties() 获取房间玩家自定义属性
int	getTargetActorId() 获取修改自定义属性的目标玩家 Actor Id
SetPlayerPropertiesRequest	setExpectedValues(PlayObject casAttr) 设置 CAS 操作用于匹配的玩家自定义属性。设置了用于匹配的自定义属性后，只有当玩家在房间内属性符合 匹配的值后更新玩家属性操作才会生效。
SetPlayerPropertiesRequest	setProperties(PlayObject attr) 设置房间玩家自定义属性
SetPlayerPropertiesRequest	setTargetActorId(int actorId) 设置修改自定义属性的目标玩家 Actor Id
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

SetPlayerPropertiesRequest

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

Method Detail

getProperties

public PlayObject getProperties()

获取房间玩家自定义属性

Returns:

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

setProperties

public SetPlayerPropertiesRequest setProperties(PlayObject attr)

设置房间玩家自定义属性

Parameters:

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

Returns:

this

getExpectedValues

public PlayObject getExpectedValues()

获取 CAS 操作用于匹配的玩家自定义属性。设置了用于匹配的自定义属性后，只有当玩家在房间内属性符合 匹配的值后更新玩家属性操作才会生效。

Returns:

用于匹配的玩家自定义属性

setExpectedValues

public SetPlayerPropertiesRequest setExpectedValues(PlayObject casAttr)

设置 CAS 操作用于匹配的玩家自定义属性。设置了用于匹配的自定义属性后，只有当玩家在房间内属性符合 匹配的值后更新玩家属性操作才会生效。

Parameters:

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

Returns:

this

getTargetActorId

public int getTargetActorId()

获取修改自定义属性的目标玩家 Actor Id

Returns:

目标玩家 Actor Id

setTargetActorId

public SetPlayerPropertiesRequest setTargetActorId(int actorId)

设置修改自定义属性的目标玩家 Actor Id

Parameters:

actorId - 目标玩家 Actor Id

Returns:

this

toString

public String toString()

Overrides:

toString in class Object