com.tencentcloudapi.lcic.v20220817.models

Class KickUserFromRoomRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.lcic.v20220817.models.KickUserFromRoomRequest

public class KickUserFromRoomRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
KickUserFromRoomRequest()
KickUserFromRoomRequest(KickUserFromRoomRequest 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

Modifier and Type	Method and Description
Long	getDuration() Get The ban duration (seconds).
Long	getKickType() Get The removal type: `1`: Keep the user out temporarily.
Long	getRoomId() Get The room ID.
Long	getSdkAppId() Get The SDKAppID assigned by LCIC.
String	getUserId() Get The ID of the user to be removed.
void	setDuration(Long Duration) Set The ban duration (seconds).
void	setKickType(Long KickType) Set The removal type: `1`: Keep the user out temporarily.
void	setRoomId(Long RoomId) Set The room ID.
void	setSdkAppId(Long SdkAppId) Set The SDKAppID assigned by LCIC.
void	setUserId(String UserId) Set The ID of the user to be removed.
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, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

Methods inherited from class java.lang.Object

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

Constructor Detail

KickUserFromRoomRequest

public KickUserFromRoomRequest()

KickUserFromRoomRequest

public KickUserFromRoomRequest(KickUserFromRoomRequest 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

getRoomId

public Long getRoomId()

Get The room ID.

Returns:

RoomId The room ID.

setRoomId

public void setRoomId(Long RoomId)

Set The room ID.

Parameters:

RoomId - The room ID.

getSdkAppId

public Long getSdkAppId()

Get The SDKAppID assigned by LCIC.

Returns:

SdkAppId The SDKAppID assigned by LCIC.

setSdkAppId

public void setSdkAppId(Long SdkAppId)

Set The SDKAppID assigned by LCIC.

Parameters:

SdkAppId - The SDKAppID assigned by LCIC.

getUserId

public String getUserId()

Get The ID of the user to be removed.

Returns:

UserId The ID of the user to be removed.

setUserId

public void setUserId(String UserId)

Set The ID of the user to be removed.

Parameters:

UserId - The ID of the user to be removed.

getKickType

public Long getKickType()

Get The removal type: `1`: Keep the user out temporarily. The `Duration` parameter specifies the ban duration, during which the user is banned from entering the room. `2`: Remove the user permanently.

Returns:

KickType The removal type: `1`: Keep the user out temporarily. The `Duration` parameter specifies the ban duration, during which the user is banned from entering the room. `2`: Remove the user permanently.

setKickType

public void setKickType(Long KickType)

Set The removal type: `1`: Keep the user out temporarily. The `Duration` parameter specifies the ban duration, during which the user is banned from entering the room. `2`: Remove the user permanently.

Parameters:

KickType - The removal type: `1`: Keep the user out temporarily. The `Duration` parameter specifies the ban duration, during which the user is banned from entering the room. `2`: Remove the user permanently.

getDuration

public Long getDuration()

Get The ban duration (seconds). This parameter is valid if `KickType` is `1`. The default value is `0`.

Returns:

Duration The ban duration (seconds). This parameter is valid if `KickType` is `1`. The default value is `0`.

setDuration

public void setDuration(Long Duration)

Set The ban duration (seconds). This parameter is valid if `KickType` is `1`. The default value is `0`.

Parameters:

Duration - The ban duration (seconds). This parameter is valid if `KickType` is `1`. The default value is `0`.

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel

Parameters:

map - The map to populate with the model's parameters.

prefix - A string prefix for the keys.