Room (tencentcloud-sdk-java 3.1.502 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractModel
- - com.tencentcloudapi.mgobe.v20201014.models.Room

```
public class Room
extends AbstractModel
```

Constructor Summary

Constructors
Constructor and Description
`Room()`
`Room(Room source)` NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Long`	`getCreateTime()` Get 表示房间创建的时间戳（单位：秒）。
`Long`	`getCreateType()` Get 表示创建方式：0.单人主动发起创建房间请求；1.多人在线匹配请求分配房间；2.
`String`	`getCustomProperties()` Get 表示自定义房间属性，不传为空字符串。最长不超过1024个字符。
`Long`	`getFrameRate()` Get 表示帧率。由控制台设置，用于出参。
`Long`	`getFrameSyncState()` Get 表示房间帧同步状态。0表示未开始帧同步，1表示已开始帧同步，用于出参。
`String`	`getId()` Get 表示房间 ID。出参用，由后端返回。
`Boolean`	`getIsForbidJoin()` Get 表示是否禁止加入房间。出参使用，默认为False，通过SDK的ChangeRoom接口可以修改。
`Boolean`	`getIsPrivate()` Get 表示是否私有，私有指的是不允许其他玩家通过匹配加入房间。
`Long`	`getMaxPlayers()` Get 表示房间最大玩家数量。最大不超过100人。
`String`	`getName()` Get 表示房间名称。最长不超过32个字符。
`String`	`getOwner()` Get 表示房主PlayerId。
`String`	`getOwnerOpenId()` Get 表示房主OpenId。最长不超过16个字符。
`Player[]`	`getPlayers()` Get 表示玩家详情列表。
`String`	`getRouteId()` Get 表示路由ID。用于出参。
`Long`	`getStartGameTime()` Get 表示开始帧同步时的时间戳（单位：秒）,未开始帧同步时返回为0。
`Team[]`	`getTeams()` Get 表示团队属性列表。
`String`	`getType()` Get 表示房间类型。最长不超过32个字符。
`void`	`setCreateTime(Long CreateTime)` Set 表示房间创建的时间戳（单位：秒）。
`void`	`setCreateType(Long CreateType)` Set 表示创建方式：0.单人主动发起创建房间请求；1.多人在线匹配请求分配房间；2.
`void`	`setCustomProperties(String CustomProperties)` Set 表示自定义房间属性，不传为空字符串。最长不超过1024个字符。
`void`	`setFrameRate(Long FrameRate)` Set 表示帧率。由控制台设置，用于出参。
`void`	`setFrameSyncState(Long FrameSyncState)` Set 表示房间帧同步状态。0表示未开始帧同步，1表示已开始帧同步，用于出参。
`void`	`setId(String Id)` Set 表示房间 ID。出参用，由后端返回。
`void`	`setIsForbidJoin(Boolean IsForbidJoin)` Set 表示是否禁止加入房间。出参使用，默认为False，通过SDK的ChangeRoom接口可以修改。
`void`	`setIsPrivate(Boolean IsPrivate)` Set 表示是否私有，私有指的是不允许其他玩家通过匹配加入房间。
`void`	`setMaxPlayers(Long MaxPlayers)` Set 表示房间最大玩家数量。最大不超过100人。
`void`	`setName(String Name)` Set 表示房间名称。最长不超过32个字符。
`void`	`setOwner(String Owner)` Set 表示房主PlayerId。
`void`	`setOwnerOpenId(String OwnerOpenId)` Set 表示房主OpenId。最长不超过16个字符。
`void`	`setPlayers(Player[] Players)` Set 表示玩家详情列表。
`void`	`setRouteId(String RouteId)` Set 表示路由ID。用于出参。
`void`	`setStartGameTime(Long StartGameTime)` Set 表示开始帧同步时的时间戳（单位：秒）,未开始帧同步时返回为0。
`void`	`setTeams(Team[] Teams)` Set 表示团队属性列表。
`void`	`setType(String Type)` Set 表示房间类型。最长不超过32个字符。
`void`	`toMap(HashMap<String,String> map, String prefix)` Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel
any, fromJsonString, getBinaryParams, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Room
```
public Room()
```
  - Room
```
public Room(Room source)
```
    NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.
- Method Detail
  - getName
```
public String getName()
```
    Get 表示房间名称。最长不超过32个字符。
    
    Returns:
    
    Name 表示房间名称。最长不超过32个字符。
  - setName
```
public void setName(String Name)
```
    Set 表示房间名称。最长不超过32个字符。
    
    Parameters:
    
    Name - 表示房间名称。最长不超过32个字符。
  - getMaxPlayers
```
public Long getMaxPlayers()
```
    Get 表示房间最大玩家数量。最大不超过100人。
    
    Returns:
    
    MaxPlayers 表示房间最大玩家数量。最大不超过100人。
  - setMaxPlayers
```
public void setMaxPlayers(Long MaxPlayers)
```
    Set 表示房间最大玩家数量。最大不超过100人。
    
    Parameters:
    
    MaxPlayers - 表示房间最大玩家数量。最大不超过100人。
  - getOwnerOpenId
```
public String getOwnerOpenId()
```
    Get 表示房主OpenId。最长不超过16个字符。
    
    Returns:
    
    OwnerOpenId 表示房主OpenId。最长不超过16个字符。
  - setOwnerOpenId
```
public void setOwnerOpenId(String OwnerOpenId)
```
    Set 表示房主OpenId。最长不超过16个字符。
    
    Parameters:
    
    OwnerOpenId - 表示房主OpenId。最长不超过16个字符。
  - getIsPrivate
```
public Boolean getIsPrivate()
```
    Get 表示是否私有，私有指的是不允许其他玩家通过匹配加入房间。
    
    Returns:
    
    IsPrivate 表示是否私有，私有指的是不允许其他玩家通过匹配加入房间。
  - setIsPrivate
```
public void setIsPrivate(Boolean IsPrivate)
```
    Set 表示是否私有，私有指的是不允许其他玩家通过匹配加入房间。
    
    Parameters:
    
    IsPrivate - 表示是否私有，私有指的是不允许其他玩家通过匹配加入房间。
  - getPlayers
```
public Player[] getPlayers()
```
    Get 表示玩家详情列表。
    
    Returns:
    
    Players 表示玩家详情列表。
  - setPlayers
```
public void setPlayers(Player[] Players)
```
    Set 表示玩家详情列表。
    
    Parameters:
    
    Players - 表示玩家详情列表。
  - getTeams
```
public Team[] getTeams()
```
    Get 表示团队属性列表。
    
    Returns:
    
    Teams 表示团队属性列表。
  - setTeams
```
public void setTeams(Team[] Teams)
```
    Set 表示团队属性列表。
    
    Parameters:
    
    Teams - 表示团队属性列表。
  - getId
```
public String getId()
```
    Get 表示房间 ID。出参用，由后端返回。
    
    Returns:
    
    Id 表示房间 ID。出参用，由后端返回。
  - setId
```
public void setId(String Id)
```
    Set 表示房间 ID。出参用，由后端返回。
    
    Parameters:
    
    Id - 表示房间 ID。出参用，由后端返回。
  - getType
```
public String getType()
```
    Get 表示房间类型。最长不超过32个字符。
    
    Returns:
    
    Type 表示房间类型。最长不超过32个字符。
  - setType
```
public void setType(String Type)
```
    Set 表示房间类型。最长不超过32个字符。
    
    Parameters:
    
    Type - 表示房间类型。最长不超过32个字符。
  - getCreateType
```
public Long getCreateType()
```
    Get 表示创建方式：0.单人主动发起创建房间请求；1.多人在线匹配请求分配房间；2. 直接创建满员房间。调用云API的创房请求默认为3，目前通过云API调用只支持第3种方式。
    
    Returns:
    
    CreateType 表示创建方式：0.单人主动发起创建房间请求；1.多人在线匹配请求分配房间；2. 直接创建满员房间。调用云API的创房请求默认为3，目前通过云API调用只支持第3种方式。
  - setCreateType
```
public void setCreateType(Long CreateType)
```
    Set 表示创建方式：0.单人主动发起创建房间请求；1.多人在线匹配请求分配房间；2. 直接创建满员房间。调用云API的创房请求默认为3，目前通过云API调用只支持第3种方式。
    
    Parameters:
    
    CreateType - 表示创建方式：0.单人主动发起创建房间请求；1.多人在线匹配请求分配房间；2. 直接创建满员房间。调用云API的创房请求默认为3，目前通过云API调用只支持第3种方式。
  - getCustomProperties
```
public String getCustomProperties()
```
    Get 表示自定义房间属性，不传为空字符串。最长不超过1024个字符。
    
    Returns:
    
    CustomProperties 表示自定义房间属性，不传为空字符串。最长不超过1024个字符。
  - setCustomProperties
```
public void setCustomProperties(String CustomProperties)
```
    Set 表示自定义房间属性，不传为空字符串。最长不超过1024个字符。
    
    Parameters:
    
    CustomProperties - 表示自定义房间属性，不传为空字符串。最长不超过1024个字符。
  - getFrameSyncState
```
public Long getFrameSyncState()
```
    Get 表示房间帧同步状态。0表示未开始帧同步，1表示已开始帧同步，用于出参。
    
    Returns:
    
    FrameSyncState 表示房间帧同步状态。0表示未开始帧同步，1表示已开始帧同步，用于出参。
  - setFrameSyncState
```
public void setFrameSyncState(Long FrameSyncState)
```
    Set 表示房间帧同步状态。0表示未开始帧同步，1表示已开始帧同步，用于出参。
    
    Parameters:
    
    FrameSyncState - 表示房间帧同步状态。0表示未开始帧同步，1表示已开始帧同步，用于出参。
  - getFrameRate
```
public Long getFrameRate()
```
    Get 表示帧率。由控制台设置，用于出参。
    
    Returns:
    
    FrameRate 表示帧率。由控制台设置，用于出参。
  - setFrameRate
```
public void setFrameRate(Long FrameRate)
```
    Set 表示帧率。由控制台设置，用于出参。
    
    Parameters:
    
    FrameRate - 表示帧率。由控制台设置，用于出参。
  - getRouteId
```
public String getRouteId()
```
    Get 表示路由ID。用于出参。
    
    Returns:
    
    RouteId 表示路由ID。用于出参。
  - setRouteId
```
public void setRouteId(String RouteId)
```
    Set 表示路由ID。用于出参。
    
    Parameters:
    
    RouteId - 表示路由ID。用于出参。
  - getCreateTime
```
public Long getCreateTime()
```
    Get 表示房间创建的时间戳（单位：秒）。
    
    Returns:
    
    CreateTime 表示房间创建的时间戳（单位：秒）。
  - setCreateTime
```
public void setCreateTime(Long CreateTime)
```
    Set 表示房间创建的时间戳（单位：秒）。
    
    Parameters:
    
    CreateTime - 表示房间创建的时间戳（单位：秒）。
  - getStartGameTime
```
public Long getStartGameTime()
```
    Get 表示开始帧同步时的时间戳（单位：秒）,未开始帧同步时返回为0。
    
    Returns:
    
    StartGameTime 表示开始帧同步时的时间戳（单位：秒）,未开始帧同步时返回为0。
  - setStartGameTime
```
public void setStartGameTime(Long StartGameTime)
```
    Set 表示开始帧同步时的时间戳（单位：秒）,未开始帧同步时返回为0。
    
    Parameters:
    
    StartGameTime - 表示开始帧同步时的时间戳（单位：秒）,未开始帧同步时返回为0。
  - getIsForbidJoin
```
public Boolean getIsForbidJoin()
```
    Get 表示是否禁止加入房间。出参使用，默认为False，通过SDK的ChangeRoom接口可以修改。
    
    Returns:
    
    IsForbidJoin 表示是否禁止加入房间。出参使用，默认为False，通过SDK的ChangeRoom接口可以修改。
  - setIsForbidJoin
```
public void setIsForbidJoin(Boolean IsForbidJoin)
```
    Set 表示是否禁止加入房间。出参使用，默认为False，通过SDK的ChangeRoom接口可以修改。
    
    Parameters:
    
    IsForbidJoin - 表示是否禁止加入房间。出参使用，默认为False，通过SDK的ChangeRoom接口可以修改。
  - getOwner
```
public String getOwner()
```
    Get 表示房主PlayerId。
    
    Returns:
    
    Owner 表示房主PlayerId。
  - setOwner
```
public void setOwner(String Owner)
```
    Set 表示房主PlayerId。
    
    Parameters:
    
    Owner - 表示房主PlayerId。
  - toMap
```
public void toMap(HashMap<String,String> map,
                  String prefix)
```
    Internal implementation, normal users should not use it.
    
    Specified by:
    
    toMap in class AbstractModel

Class Room

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractModel

Methods inherited from class java.lang.Object

Constructor Detail

Room

Room

Method Detail

getName

setName

getMaxPlayers

setMaxPlayers

getOwnerOpenId

setOwnerOpenId

getIsPrivate

setIsPrivate

getPlayers

setPlayers

getTeams

setTeams

getId

setId

getType

setType

getCreateType

setCreateType

getCustomProperties

setCustomProperties

getFrameSyncState

setFrameSyncState

getFrameRate

setFrameRate

getRouteId

setRouteId

getCreateTime

setCreateTime

getStartGameTime

setStartGameTime

getIsForbidJoin

setIsForbidJoin

getOwner

setOwner

toMap