cn.leancloud.play.plugin.request

Class SetRoomSystemPropertiesRequest.ExpectedUserIdsProperty

java.lang.Object

cn.leancloud.play.plugin.request.SetRoomSystemPropertiesRequest.ExpectedUserIdsProperty

All Implemented Interfaces:

RoomSystemProperty<Set<String>>

Enclosing class:

SetRoomSystemPropertiesRequest

public static final class SetRoomSystemPropertiesRequest.ExpectedUserIdsProperty
extends Object
implements RoomSystemProperty<Set<String>>

房间邀请好友列表属性。加入邀请好友列表后，相当于帮好友在房间内做了 "占位"，即使房间满了好友也能加入房间。

修改房间邀请好友列表我们支持四种操作，对应四种 SetRoomSystemPropertiesRequest.Operator：

Operator.ADD 在现有房间邀请好友列表上增加新的待邀请好友。比如房间现有好友 ["a", "b", "c"]， 执行 ADD ["c", "d"] 后，房间邀请好友列表结果为 ["a", "b", "c", "d"]

Operator.REMOVE 在现有房间邀请好友列表上删除一组好友 ID。比如房间现有好友 ["a", "b", "c"]， 执行 REMOVE ["c", "d"] 后，房间邀请好友列表结果为 ["a", "b"]

Operator.SET 用新的邀请列表替换现有房间邀请好友列表。比如房间现有好友 ["a", "b", "c"]，执行 SET ["c", "d"] 后，房间邀请好友列表结果为 ["c", "d"]

Operator.DROP 清空现有房间邀请好友列表。比如房间现有好友 ["a", "b", "c"]，执行 DROP 后，房间邀请好友列表结果为 [ ]

Method Summary

Modifier and Type	Method and Description
static SetRoomSystemPropertiesRequest.ExpectedUserIdsProperty	add(Set<String> valueToSet) 在现有房间邀请好友列表上增加新的待邀请好友。比如房间现有好友 ["a", "b", "c"]， 参数为 ["c", "d"]，执行后房间邀请好友列表结果为 ["a", "b", "c", "d"]
static SetRoomSystemPropertiesRequest.ExpectedUserIdsProperty	drop() 清空现有房间邀请好友列表。比如房间现有好友 ["a", "b", "c"]，执行后房间邀请好友列 表结果为 [ ]
SetRoomSystemPropertiesRequest.Operator	getOperator() 获取邀请好友列表操作数，可以是 ADD，REMOVE，SET，DROP 之一。
clojure.lang.Keyword	getPropertyKey() 房间属性 Key，Game Server 使用，Game Plugin 实现者无需使用
Set<String>	getPropertyValueToSet() 房间属性值
Object	getSerializedPropertyValue() Game Server 内使用的房间属性值，Game Plugin 实现者无需使用
static SetRoomSystemPropertiesRequest.ExpectedUserIdsProperty	remove(Set<String> valueToSet) 在现有房间邀请好友列表中删除一组好友 ID。比如房间现有好友 ["a", "b", "c"]， 参数为 ["c", "d"]，执行后房间邀请好友列表结果为 ["a", "b"]
static SetRoomSystemPropertiesRequest.ExpectedUserIdsProperty	set(Set<String> valueToSet) 用新的邀请列表替换现有房间邀请好友列表。比如房间现有好友 ["a", "b", "c"]， 参数为 ["c", "d"]，执行后房间邀请好友列表结果为 ["c", "d"]
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

add

public static SetRoomSystemPropertiesRequest.ExpectedUserIdsProperty add(Set<String> valueToSet)

在现有房间邀请好友列表上增加新的待邀请好友。比如房间现有好友 ["a", "b", "c"]， 参数为 ["c", "d"]，执行后房间邀请好友列表结果为 ["a", "b", "c", "d"]

Parameters:

valueToSet - 待添加新的邀请好友 ID 列表

Returns:

this

remove

public static SetRoomSystemPropertiesRequest.ExpectedUserIdsProperty remove(Set<String> valueToSet)

在现有房间邀请好友列表中删除一组好友 ID。比如房间现有好友 ["a", "b", "c"]， 参数为 ["c", "d"]，执行后房间邀请好友列表结果为 ["a", "b"]

Parameters:

valueToSet - 待删除好友 ID 列表

Returns:

this

set

public static SetRoomSystemPropertiesRequest.ExpectedUserIdsProperty set(Set<String> valueToSet)

用新的邀请列表替换现有房间邀请好友列表。比如房间现有好友 ["a", "b", "c"]， 参数为 ["c", "d"]，执行后房间邀请好友列表结果为 ["c", "d"]

Parameters:

valueToSet - 待删除好友 ID 列表

Returns:

this

drop

public static SetRoomSystemPropertiesRequest.ExpectedUserIdsProperty drop()

清空现有房间邀请好友列表。比如房间现有好友 ["a", "b", "c"]，执行后房间邀请好友列 表结果为 [ ]

Returns:

this

getPropertyKey

public clojure.lang.Keyword getPropertyKey()

Description copied from interface: RoomSystemProperty

房间属性 Key，Game Server 使用，Game Plugin 实现者无需使用

Specified by:

getPropertyKey in interface RoomSystemProperty<Set<String>>

Returns:

房间属性 Key

getPropertyValueToSet

public Set<String> getPropertyValueToSet()

Description copied from interface: RoomSystemProperty

房间属性值

Specified by:

getPropertyValueToSet in interface RoomSystemProperty<Set<String>>

Returns:

房间属性值

getOperator

public SetRoomSystemPropertiesRequest.Operator getOperator()

获取邀请好友列表操作数，可以是 ADD，REMOVE，SET，DROP 之一。

Returns:

邀请好友列表操作数

getSerializedPropertyValue

public Object getSerializedPropertyValue()

Description copied from interface: RoomSystemProperty

Game Server 内使用的房间属性值，Game Plugin 实现者无需使用

Specified by:

getSerializedPropertyValue in interface RoomSystemProperty<Set<String>>

Returns:

房间属性值

toString

public String toString()

Overrides:

toString in class Object