tencentcloud-sdk-nodejs-lcic 4.0.449

package/src/services/lcic/v20220817/lcic_models.ts

@@ -0,0 +1,371 @@
+/*
+ * Copyright (c) 2018 THL A29 Limited, a Tencent company. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+/**
+ * CreateRoom请求参数结构体
+ */
+export interface CreateRoomRequest {
+  /**
+   * 房间名称。
+   */
+  Name: string
+
+  /**
+   * 预定的房间开始时间，unix时间戳。
+   */
+  StartTime: number
+
+  /**
+   * 预定的房间结束时间，unix时间戳。
+   */
+  EndTime: number
+
+  /**
+   * 低代码互动课堂的SdkAppId。
+   */
+  SdkAppId: number
+
+  /**
+      * 分辨率。可以有如下取值：
+1 标清
+2 高清
+3 全高清
+      */
+  Resolution: number
+
+  /**
+   * 最大连麦人数（不包括老师）。取值范围[0, 17)
+   */
+  MaxMicNumber: number
+
+  /**
+      * 房间子类型，可以有以下取值：
+videodoc 文档+视频
+video 纯视频
+coteaching 双师
+      */
+  SubType: string
+
+  /**
+   * 老师ID。
+   */
+  TeacherId?: string
+
+  /**
+      * 进入房间时是否自动连麦。可以有以下取值：
+0 不自动连麦（默认值）
+1 自动连麦
+      */
+  AutoMic?: number
+
+  /**
+      * 高音质模式。可以有以下取值：
+0 不开启高音质（默认值）
+1 开启高音质
+      */
+  AudioQuality?: number
+
+  /**
+      * 禁止录制。可以有以下取值：
+0 不禁止录制（默认值）
+1 禁止录制
+      */
+  DisableRecord?: number
+
+  /**
+   * 助教Id列表。
+   */
+  Assistants?: Array<string>
+
+  /**
+   * 录制布局。
+   */
+  RecordLayout?: number
+}
+
+/**
+ * CreateSupervisor请求参数结构体
+ */
+export type CreateSupervisorRequest = null
+
+/**
+ * DescribeRoom返回参数结构体
+ */
+export interface DescribeRoomResponse {
+  /**
+   * 房间名称。
+   */
+  Name: string
+
+  /**
+   * 预定的房间开始时间，unix时间戳。
+   */
+  StartTime: number
+
+  /**
+   * 预定的房间结束时间，unix时间戳。
+   */
+  EndTime: number
+
+  /**
+   * 老师ID。
+   */
+  TeacherId: string
+
+  /**
+   * 低代码互动课堂的SdkAppId。
+   */
+  SdkAppId: number
+
+  /**
+      * 分辨率。可以有如下取值：
+1 标清
+2 高清
+3 全高清
+      */
+  Resolution: number
+
+  /**
+   * 最大连麦人数（不包括老师）。取值范围[0, 17)
+   */
+  MaxMicNumber: number
+
+  /**
+      * 进入房间时是否自动连麦。可以有以下取值：
+0 不自动连麦（默认值）
+1 自动连麦
+      */
+  AutoMic: number
+
+  /**
+      * 高音质模式。可以有以下取值：
+0 不开启高音质（默认值）
+1 开启高音质
+      */
+  AudioQuality: number
+
+  /**
+      * 房间子类型，可以有以下取值：
+videodoc 文档+视频
+video 纯视频
+coteaching 双师
+      */
+  SubType: string
+
+  /**
+      * 禁止录制。可以有以下取值：
+0 不禁止录制（默认值）
+1 禁止录制
+      */
+  DisableRecord: number
+
+  /**
+      * 助教Id列表。
+注意：此字段可能返回 null，表示取不到有效值。
+      */
+  Assistants: Array<string>
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * RegisterUser请求参数结构体
+ */
+export interface RegisterUserRequest {
+  /**
+   * 低代码互动课堂的SdkAppId。
+   */
+  SdkAppId: number
+
+  /**
+   * 用户名称。
+   */
+  Name?: string
+
+  /**
+   * 用户在客户系统的Id，需要在同一应用下唯一。
+   */
+  OriginId?: string
+
+  /**
+   * 用户头像。
+   */
+  Avatar?: string
+}
+
+/**
+ * LoginOriginId请求参数结构体
+ */
+export interface LoginOriginIdRequest {
+  /**
+   * 低代码互动课堂的SdkAppId。
+   */
+  SdkAppId: number
+
+  /**
+   * 用户在客户系统的Id，需要在同一应用下唯一。
+   */
+  OriginId: string
+}
+
+/**
+ * DescribeUser请求参数结构体
+ */
+export interface DescribeUserRequest {
+  /**
+   * 用户Id。
+   */
+  UserId: string
+}
+
+/**
+ * RegisterUser返回参数结构体
+ */
+export interface RegisterUserResponse {
+  /**
+   * 用户Id。
+   */
+  UserId: string
+
+  /**
+   * 登录/注册成功后返回登录态token。有效期7天。
+   */
+  Token: string
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * LoginUser请求参数结构体
+ */
+export interface LoginUserRequest {
+  /**
+   * 注册获取的用户id。
+   */
+  UserId: string
+}
+
+/**
+ * CreateSupervisor返回参数结构体
+ */
+export interface CreateSupervisorResponse {
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * CreateRoom返回参数结构体
+ */
+export interface CreateRoomResponse {
+  /**
+   * 房间ID。
+   */
+  RoomId: number
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * DescribeUser返回参数结构体
+ */
+export interface DescribeUserResponse {
+  /**
+   * 应用Id。
+   */
+  SdkAppId: number
+
+  /**
+   * 用户Id。
+   */
+  UserId: string
+
+  /**
+   * 用户昵称。
+   */
+  Name: string
+
+  /**
+   * 用户头像Url。
+   */
+  Avatar: string
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * DescribeRoom请求参数结构体
+ */
+export interface DescribeRoomRequest {
+  /**
+   * 房间Id。
+   */
+  RoomId: number
+}
+
+/**
+ * LoginOriginId返回参数结构体
+ */
+export interface LoginOriginIdResponse {
+  /**
+   * 用户Id。
+   */
+  UserId: string
+
+  /**
+   * 登录/注册成功后返回登录态token。有效期7天。
+   */
+  Token: string
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}
+
+/**
+ * LoginUser返回参数结构体
+ */
+export interface LoginUserResponse {
+  /**
+   * 用户Id。
+   */
+  UserId: string
+
+  /**
+   * 登录/注册成功后返回登录态token。有效期7天。
+   */
+  Token: string
+
+  /**
+   * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+   */
+  RequestId?: string
+}

package/tencentcloud/index.d.ts

@@ -0,0 +1 @@
+export * from "./services";

package/tencentcloud/index.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./services"), exports);

package/tencentcloud/services/index.d.ts

@@ -0,0 +1 @@
+export { lcic } from "./lcic";

package/tencentcloud/services/index.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var lcic_1 = require("./lcic");
+Object.defineProperty(exports, "lcic", { enumerable: true, get: function () { return lcic_1.lcic; } });

package/tencentcloud/services/lcic/index.d.ts

@@ -0,0 +1,6 @@
+export declare const lcic: {
+    v20220817: {
+        Client: typeof import("./v20220817/lcic_client").Client;
+        Models: typeof import("./v20220817/lcic_models");
+    };
+};

package/tencentcloud/services/lcic/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.lcic = void 0;
+const v20220817_1 = require("./v20220817");
+exports.lcic = {
+    v20220817: v20220817_1.v20220817,
+};

package/tencentcloud/services/lcic/v20220817/index.d.ts

@@ -0,0 +1,6 @@
+import * as Models from "./lcic_models";
+import { Client } from "./lcic_client";
+export declare const v20220817: {
+    Client: typeof Client;
+    Models: typeof Models;
+};

package/tencentcloud/services/lcic/v20220817/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.v20220817 = void 0;
+const Models = require("./lcic_models");
+const lcic_client_1 = require("./lcic_client");
+exports.v20220817 = {
+    Client: lcic_client_1.Client,
+    Models: Models,
+};

package/tencentcloud/services/lcic/v20220817/lcic_client.d.ts

@@ -0,0 +1,37 @@
+import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common";
+import { CreateRoomRequest, CreateSupervisorRequest, DescribeRoomResponse, RegisterUserRequest, LoginOriginIdRequest, DescribeUserRequest, RegisterUserResponse, LoginUserRequest, CreateSupervisorResponse, CreateRoomResponse, DescribeUserResponse, DescribeRoomRequest, LoginOriginIdResponse, LoginUserResponse } from "./lcic_models";
+/**
+ * lcic client
+ * @class
+ */
+export declare class Client extends TencentCloudCommon.AbstractClient {
+    constructor(clientConfig: TencentCloudCommon.ClientConfig);
+    /**
+     * 获取用户信息
+     */
+    DescribeUser(req: DescribeUserRequest, cb?: (error: string, rep: DescribeUserResponse) => void): Promise<DescribeUserResponse>;
+    /**
+     * 使用源账号登录，源账号为注册时填入的originId
+     */
+    LoginOriginId(req: LoginOriginIdRequest, cb?: (error: string, rep: LoginOriginIdResponse) => void): Promise<LoginOriginIdResponse>;
+    /**
+     * 注册用户
+     */
+    RegisterUser(req: RegisterUserRequest, cb?: (error: string, rep: RegisterUserResponse) => void): Promise<RegisterUserResponse>;
+    /**
+     * 登录
+     */
+    LoginUser(req: LoginUserRequest, cb?: (error: string, rep: LoginUserResponse) => void): Promise<LoginUserResponse>;
+    /**
+     * 创建巡课
+     */
+    CreateSupervisor(req?: CreateSupervisorRequest, cb?: (error: string, rep: CreateSupervisorResponse) => void): Promise<CreateSupervisorResponse>;
+    /**
+     * 获取房间信息
+     */
+    DescribeRoom(req: DescribeRoomRequest, cb?: (error: string, rep: DescribeRoomResponse) => void): Promise<DescribeRoomResponse>;
+    /**
+     * 创建房间
+     */
+    CreateRoom(req: CreateRoomRequest, cb?: (error: string, rep: CreateRoomResponse) => void): Promise<CreateRoomResponse>;
+}

package/tencentcloud/services/lcic/v20220817/lcic_client.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Client = void 0;
+/* eslint-disable @typescript-eslint/no-unused-vars */
+/*
+ * Copyright (c) 2018 THL A29 Limited, a Tencent company. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+const TencentCloudCommon = require("tencentcloud-sdk-nodejs-common");
+/**
+ * lcic client
+ * @class
+ */
+class Client extends TencentCloudCommon.AbstractClient {
+    constructor(clientConfig) {
+        super("lcic.tencentcloudapi.com", "2022-08-17", clientConfig);
+    }
+    /**
+     * 获取用户信息
+     */
+    async DescribeUser(req, cb) {
+        return this.request("DescribeUser", req, cb);
+    }
+    /**
+     * 使用源账号登录，源账号为注册时填入的originId
+     */
+    async LoginOriginId(req, cb) {
+        return this.request("LoginOriginId", req, cb);
+    }
+    /**
+     * 注册用户
+     */
+    async RegisterUser(req, cb) {
+        return this.request("RegisterUser", req, cb);
+    }
+    /**
+     * 登录
+     */
+    async LoginUser(req, cb) {
+        return this.request("LoginUser", req, cb);
+    }
+    /**
+     * 创建巡课
+     */
+    async CreateSupervisor(req, cb) {
+        return this.request("CreateSupervisor", req, cb);
+    }
+    /**
+     * 获取房间信息
+     */
+    async DescribeRoom(req, cb) {
+        return this.request("DescribeRoom", req, cb);
+    }
+    /**
+     * 创建房间
+     */
+    async CreateRoom(req, cb) {
+        return this.request("CreateRoom", req, cb);
+    }
+}
+exports.Client = Client;