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.



3759
3760
3761
3762
3763
3764
3765
# File 'lib/v20220817/models.rb', line 3759

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:

  • 课堂Id。

  • 低代码平台的SdkAppId。

  • 需要踢出成员Id

  • 踢出类型:

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



3757
3758
3759
# File 'lib/v20220817/models.rb', line 3757

def Duration
  @Duration
end

#KickTypeObject

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

Parameters:

  • 课堂Id。

  • 低代码平台的SdkAppId。

  • 需要踢出成员Id

  • 踢出类型:

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



3757
3758
3759
# File 'lib/v20220817/models.rb', line 3757

def KickType
  @KickType
end

#RoomIdObject

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

Parameters:

  • 课堂Id。

  • 低代码平台的SdkAppId。

  • 需要踢出成员Id

  • 踢出类型:

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



3757
3758
3759
# File 'lib/v20220817/models.rb', line 3757

def RoomId
  @RoomId
end

#SdkAppIdObject

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

Parameters:

  • 课堂Id。

  • 低代码平台的SdkAppId。

  • 需要踢出成员Id

  • 踢出类型:

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



3757
3758
3759
# File 'lib/v20220817/models.rb', line 3757

def SdkAppId
  @SdkAppId
end

#UserIdObject

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

Parameters:

  • 课堂Id。

  • 低代码平台的SdkAppId。

  • 需要踢出成员Id

  • 踢出类型:

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



3757
3758
3759
# File 'lib/v20220817/models.rb', line 3757

def UserId
  @UserId
end

Instance Method Details

#deserialize(params) ⇒ Object



3767
3768
3769
3770
3771
3772
3773
# File 'lib/v20220817/models.rb', line 3767

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