cn.leancloud.play.plugin.request

Class SetRoomSystemPropertiesRequest

java.lang.Object

cn.leancloud.play.plugin.request.AbstractRequest

cn.leancloud.play.plugin.request.SetRoomSystemPropertiesRequest

All Implemented Interfaces:

RoomRequest

public final class SetRoomSystemPropertiesRequest
extends AbstractRequest

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SetRoomSystemPropertiesRequest.ExpectedUserIdsProperty 房间邀请好友列表属性。加入邀请好友列表后，相当于帮好友在房间内做了 "占位"，即使房间满了好友也能加入房间。
static class	SetRoomSystemPropertiesRequest.ExposeRoomProperty 房间可见性属性。房间默认为可见状态，如果房间不可见则表示新用户不能通过在大厅自动匹配房间方式加入房间。
static class	SetRoomSystemPropertiesRequest.MaxPlayerCountProperty 房间最大玩家数量属性。房间玩家数量达到上限后则房间无法再加入新玩家。
static class	SetRoomSystemPropertiesRequest.OpenRoomProperty 房间开闭属性。房间默认为开放状态，如果房间关闭则表示不能有新用户加入房间。
static class	SetRoomSystemPropertiesRequest.Operator

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Optional<SetRoomSystemPropertiesRequest.ExpectedUserIdsProperty>	getExpectedUserIdsProperty() 获取请求内是否设置邀请好友属性。
Optional<SetRoomSystemPropertiesRequest.ExposeRoomProperty>	getExposeRoomProperty() 获取请求内是否设置房间可见性属性。房间默认为可见状态，如果房间不可见则表示新用户不能通过在大厅自动匹配房间方式加入房间。
Optional<SetRoomSystemPropertiesRequest.MaxPlayerCountProperty>	getMaxPlayerCountProperty() 获取请求内是否设置房间最大玩家数量属性。
Optional<SetRoomSystemPropertiesRequest.OpenRoomProperty>	getOpenRoomProperty() 获取请求内是否设置房间开闭属性。房间默认为开放状态，如果房间关闭则表示不能有新用户加入房间。
SetRoomSystemPropertiesRequest	setExpectedUserIdsProperty(SetRoomSystemPropertiesRequest.ExpectedUserIdsProperty property) 修改本次设置房间系统属性请求，设置房间邀请好友 ID 列表。
SetRoomSystemPropertiesRequest	setExposeRoomProperty(SetRoomSystemPropertiesRequest.ExposeRoomProperty property) 修改本次设置房间系统属性请求，设置房间可见性属性。房间默认为可见状态，如果房间不可见则表示新用户不能通过在大厅 自动匹配房间方式加入房间。
SetRoomSystemPropertiesRequest	setMaxPlayerCountProperty(SetRoomSystemPropertiesRequest.MaxPlayerCountProperty property) 修改本次设置房间系统属性请求，设置房间最大玩家数量属性。房间内玩家数量达到限制后，新玩家无法再加入本房间。
SetRoomSystemPropertiesRequest	setOpenRoomProperty(SetRoomSystemPropertiesRequest.OpenRoomProperty property) 修改本次设置房间系统属性请求，设置房间开闭属性。房间默认为开放状态，如果房间关闭则表示不能有新用户加入房间。
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

SetRoomSystemPropertiesRequest

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

Method Detail

getOpenRoomProperty

public Optional<SetRoomSystemPropertiesRequest.OpenRoomProperty> getOpenRoomProperty()

获取请求内是否设置房间开闭属性。房间默认为开放状态，如果房间关闭则表示不能有新用户加入房间。

Returns:

房间开闭属性选项。使用 Optional 是因为请求内可能没有设置房间开闭属性，需要通过判断确认。

setOpenRoomProperty

public SetRoomSystemPropertiesRequest setOpenRoomProperty(SetRoomSystemPropertiesRequest.OpenRoomProperty property)

修改本次设置房间系统属性请求，设置房间开闭属性。房间默认为开放状态，如果房间关闭则表示不能有新用户加入房间。

Parameters:

property - 待设置的房间开闭属性，不能为 null

Returns:

this

getExposeRoomProperty

public Optional<SetRoomSystemPropertiesRequest.ExposeRoomProperty> getExposeRoomProperty()

获取请求内是否设置房间可见性属性。房间默认为可见状态，如果房间不可见则表示新用户不能通过在大厅自动匹配房间方式加入房间。

Returns:

房间可见性属性选项。使用 Optional 是因为请求内可能没有设置房间可见性属性，需要通过判断确认。

setExposeRoomProperty

public SetRoomSystemPropertiesRequest setExposeRoomProperty(SetRoomSystemPropertiesRequest.ExposeRoomProperty property)

修改本次设置房间系统属性请求，设置房间可见性属性。房间默认为可见状态，如果房间不可见则表示新用户不能通过在大厅 自动匹配房间方式加入房间。

Parameters:

property - 待设置的房间可见性属性，不能为 null

Returns:

this

getExpectedUserIdsProperty

public Optional<SetRoomSystemPropertiesRequest.ExpectedUserIdsProperty> getExpectedUserIdsProperty()

获取请求内是否设置邀请好友属性。

Returns:

邀请好友属性选项。使用 Optional 是因为请求内可能没有设置房间邀请好友属性，需要通过判断确认。

setExpectedUserIdsProperty

public SetRoomSystemPropertiesRequest setExpectedUserIdsProperty(SetRoomSystemPropertiesRequest.ExpectedUserIdsProperty property)

修改本次设置房间系统属性请求，设置房间邀请好友 ID 列表。

Parameters:

property - 待设置的邀请好友 ID 列表属性，不能为 null

Returns:

this

setMaxPlayerCountProperty

public SetRoomSystemPropertiesRequest setMaxPlayerCountProperty(SetRoomSystemPropertiesRequest.MaxPlayerCountProperty property)

修改本次设置房间系统属性请求，设置房间最大玩家数量属性。房间内玩家数量达到限制后，新玩家无法再加入本房间。

Parameters:

property - 待设置的房间最大玩家数量属性，不能为 null

Returns:

this

getMaxPlayerCountProperty

public Optional<SetRoomSystemPropertiesRequest.MaxPlayerCountProperty> getMaxPlayerCountProperty()

获取请求内是否设置房间最大玩家数量属性。

Returns:

房间可见性属性选项。使用 Optional 是因为请求内可能没有设置房间最大玩家数量属性，需要通过判断确认。

toString

public String toString()

Overrides:

toString in class Object