Class: TencentCloud::Lcic::V20220817::KickUserFromRoomRequest

Inherits:
Common::AbstractModel
  • Object
show all
Defined in:
lib/v20220817/models.rb

Overview

KickUserFromRoom请求参数结构体

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(roomid = nil, sdkappid = nil, userid = nil, kicktype = nil, duration = nil) ⇒ KickUserFromRoomRequest

Returns a new instance of KickUserFromRoomRequest.



3695
3696
3697
3698
3699
3700
3701
# File 'lib/v20220817/models.rb', line 3695

def initialize(roomid=nil, sdkappid=nil, userid=nil, kicktype=nil, duration=nil)
  @RoomId = roomid
  @SdkAppId = sdkappid
  @UserId = userid
  @KickType = kicktype
  @Duration = duration
end

Instance Attribute Details

#DurationObject

1:临时踢出,可以使用Duration参数指定污点时间,污点时间间隔内用户无法进入房间。2:永久踢出

Parameters:

  • RoomId:

    课堂Id。

  • SdkAppId:

    低代码平台的SdkAppId。

  • UserId:

    需要踢出成员Id

  • KickType:

    踢出类型:

  • Duration:

    污点时间(单位秒),KickType = 1时生效,默认为0



3693
3694
3695
# File 'lib/v20220817/models.rb', line 3693

def Duration
  @Duration
end

#KickTypeObject

1:临时踢出,可以使用Duration参数指定污点时间,污点时间间隔内用户无法进入房间。2:永久踢出

Parameters:

  • RoomId:

    课堂Id。

  • SdkAppId:

    低代码平台的SdkAppId。

  • UserId:

    需要踢出成员Id

  • KickType:

    踢出类型:

  • Duration:

    污点时间(单位秒),KickType = 1时生效,默认为0



3693
3694
3695
# File 'lib/v20220817/models.rb', line 3693

def KickType
  @KickType
end

#RoomIdObject

1:临时踢出,可以使用Duration参数指定污点时间,污点时间间隔内用户无法进入房间。2:永久踢出

Parameters:

  • RoomId:

    课堂Id。

  • SdkAppId:

    低代码平台的SdkAppId。

  • UserId:

    需要踢出成员Id

  • KickType:

    踢出类型:

  • Duration:

    污点时间(单位秒),KickType = 1时生效,默认为0



3693
3694
3695
# File 'lib/v20220817/models.rb', line 3693

def RoomId
  @RoomId
end

#SdkAppIdObject

1:临时踢出,可以使用Duration参数指定污点时间,污点时间间隔内用户无法进入房间。2:永久踢出

Parameters:

  • RoomId:

    课堂Id。

  • SdkAppId:

    低代码平台的SdkAppId。

  • UserId:

    需要踢出成员Id

  • KickType:

    踢出类型:

  • Duration:

    污点时间(单位秒),KickType = 1时生效,默认为0



3693
3694
3695
# File 'lib/v20220817/models.rb', line 3693

def SdkAppId
  @SdkAppId
end

#UserIdObject

1:临时踢出,可以使用Duration参数指定污点时间,污点时间间隔内用户无法进入房间。2:永久踢出

Parameters:

  • RoomId:

    课堂Id。

  • SdkAppId:

    低代码平台的SdkAppId。

  • UserId:

    需要踢出成员Id

  • KickType:

    踢出类型:

  • Duration:

    污点时间(单位秒),KickType = 1时生效,默认为0



3693
3694
3695
# File 'lib/v20220817/models.rb', line 3693

def UserId
  @UserId
end

Instance Method Details

#deserialize(params) ⇒ Object



3703
3704
3705
3706
3707
3708
3709
# File 'lib/v20220817/models.rb', line 3703

def deserialize(params)
  @RoomId = params['RoomId']
  @SdkAppId = params['SdkAppId']
  @UserId = params['UserId']
  @KickType = params['KickType']
  @Duration = params['Duration']
end