cn.leancloud.play.plugin.request

Class LeaveRoomRequest

java.lang.Object

cn.leancloud.play.plugin.request.AbstractRequest

cn.leancloud.play.plugin.request.LeaveRoomRequest

All Implemented Interfaces:

RoomRequest

public final class LeaveRoomRequest
extends AbstractRequest

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	byMaster() 玩家是否因为被 Master 踢出房间
int	getFromActorId() 获取发起离开房间操作的 Actor Id。如果是某 Actor 自己要离开房间，则返回 待离开房间 Actor 的 Id。如果是某 Actor 被踢，则这里获取的是发起踢人操作 的 Actor 的 Id。
Reason	getLeaveRoomReason() 获取自定义离开房间原因，只有在踢人场景下发起踢人请求一方可以提供踢人原因，Actor 自 己主动离开房间或因为断线而离开房间时不提供原因。
int	getTargetActorId() 获取将要离开本房间的 Actor Id。如果是某 Actor 自己要离开房间，则返回 待离开房间 Actor 的 Id。如果是某 Actor 被踢，则这里获取的是被踢 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

LeaveRoomRequest

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

Method Detail

getFromActorId

public int getFromActorId()

获取发起离开房间操作的 Actor Id。如果是某 Actor 自己要离开房间，则返回 待离开房间 Actor 的 Id。如果是某 Actor 被踢，则这里获取的是发起踢人操作 的 Actor 的 Id。

Returns:

发起离开房间操作的 Actor Id

getTargetActorId

public int getTargetActorId()

获取将要离开本房间的 Actor Id。如果是某 Actor 自己要离开房间，则返回 待离开房间 Actor 的 Id。如果是某 Actor 被踢，则这里获取的是被踢 Actor 的 Id。

Returns:

即将离开本房间的 Actor Id，返回 -1 表示程序有问题

getLeaveRoomReason

public Reason getLeaveRoomReason()

获取自定义离开房间原因，只有在踢人场景下发起踢人请求一方可以提供踢人原因，Actor 自 己主动离开房间或因为断线而离开房间时不提供原因。

Returns:

自定义离开房间原因

byMaster

public boolean byMaster()

玩家是否因为被 Master 踢出房间

Returns:

是否被 Master 踢出房间

toString

public String toString()

Overrides:

toString in class Object