TiwClient (tencentcloud-sdk-java-intl-en 3.0.926 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractClient
- - com.tencentcloudapi.tiw.v20190919.TiwClient

public class TiwClient
extends AbstractClient

Field Summary
- Fields inherited from class com.tencentcloudapi.common.AbstractClient
  gson, HTTP_RSP_OK, SDK_VERSION

Constructor Summary

Constructors
Constructor and Description
`TiwClient(Credential credential, String region)`
`TiwClient(Credential credential, String region, ClientProfile profile)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ApplyTiwTrialResponse`	`ApplyTiwTrial(ApplyTiwTrialRequest req)` This API is used to apply for a Tencent Interactive Whiteboard trial (15-day by default).
`CreateApplicationResponse`	`CreateApplication(CreateApplicationRequest req)` This API is used to create a whiteboard application.
`CreateSnapshotTaskResponse`	`CreateSnapshotTask(CreateSnapshotTaskRequest req)` This API is used to create a whiteboard snapshot task.
`CreateTranscodeResponse`	`CreateTranscode(CreateTranscodeRequest req)` This API is used to create a document transcoding task.
`CreateVideoGenerationTaskResponse`	`CreateVideoGenerationTask(CreateVideoGenerationTaskRequest req)` This API is used to create a recording video generation task.
`DescribeAPIServiceResponse`	`DescribeAPIService(DescribeAPIServiceRequest req)` This API is used to query the information about other cloud products by using the service role.
`DescribeApplicationInfosResponse`	`DescribeApplicationInfos(DescribeApplicationInfosRequest req)` This API is used to query the details of a whiteboard application.
`DescribeApplicationUsageResponse`	`DescribeApplicationUsage(DescribeApplicationUsageRequest req)` This API is used to query the subproduct usage of Tencent Interactive Whiteboard.
`DescribeBoardSDKLogResponse`	`DescribeBoardSDKLog(DescribeBoardSDKLogRequest req)` This API is used to query the logs of a whiteboard application on a client.
`DescribeIMApplicationsResponse`	`DescribeIMApplications(DescribeIMApplicationsRequest req)` This API is used to query the instant messaging (IM) applications that are available for creating a whiteboard application.
`DescribeOnlineRecordResponse`	`DescribeOnlineRecord(DescribeOnlineRecordRequest req)` This API is used to query the status and result of a real-time recording task.
`DescribeOnlineRecordCallbackResponse`	`DescribeOnlineRecordCallback(DescribeOnlineRecordCallbackRequest req)` This API is used to query the real-time recording callback address.
`DescribePostpaidUsageResponse`	`DescribePostpaidUsage(DescribePostpaidUsageRequest req)` This API is used to query the pay-as-you-go usage of a user.
`DescribeQualityMetricsResponse`	`DescribeQualityMetrics(DescribeQualityMetricsRequest req)` This API is used to query the quality data of a whiteboard application.
`DescribeRecordSearchResponse`	`DescribeRecordSearch(DescribeRecordSearchRequest req)` This API is used to query real-time recording tasks by room ID.
`DescribeRoomListResponse`	`DescribeRoomList(DescribeRoomListRequest req)` This API is used to query the rooms of a whiteboard application.
`DescribeSnapshotTaskResponse`	`DescribeSnapshotTask(DescribeSnapshotTaskRequest req)` This API is used to query the information about a whiteboard snapshot task.
`DescribeTIWDailyUsageResponse`	`DescribeTIWDailyUsage(DescribeTIWDailyUsageRequest req)` This API is used to query the daily billable usage of a whiteboard application.
`DescribeTIWRoomDailyUsageResponse`	`DescribeTIWRoomDailyUsage(DescribeTIWRoomDailyUsageRequest req)` This API is used to query the daily billable usage by each room of a whiteboard application.
`DescribeTranscodeResponse`	`DescribeTranscode(DescribeTranscodeRequest req)` This API is used to query the progress and result of a document transcoding task.
`DescribeTranscodeCallbackResponse`	`DescribeTranscodeCallback(DescribeTranscodeCallbackRequest req)` This API is used to query the document transcoding callback address.
`DescribeTranscodeSearchResponse`	`DescribeTranscodeSearch(DescribeTranscodeSearchRequest req)` This API is used to query transcoding tasks by document name.
`DescribeUsageSummaryResponse`	`DescribeUsageSummary(DescribeUsageSummaryRequest req)` This API is used to query the summary of subproduct usage within a specified period of time.
`DescribeUserListResponse`	`DescribeUserList(DescribeUserListRequest req)` This API is used to query the users of a whiteboard application.
`DescribeUserResourcesResponse`	`DescribeUserResources(DescribeUserResourcesRequest req)` This API is used to query user resources.
`DescribeUserStatusResponse`	`DescribeUserStatus(DescribeUserStatusRequest req)` This API is used to query the Tencent Interactive Whiteboard service status of a user, including the activation status and validity period.
`DescribeVideoGenerationTaskResponse`	`DescribeVideoGenerationTask(DescribeVideoGenerationTaskRequest req)` This API is used to query the status and result of a recording video generation task.
`DescribeVideoGenerationTaskCallbackResponse`	`DescribeVideoGenerationTaskCallback(DescribeVideoGenerationTaskCallbackRequest req)` This API is used to query the callback URL for recording video generation.
`DescribeWhiteboardApplicationConfigResponse`	`DescribeWhiteboardApplicationConfig(DescribeWhiteboardApplicationConfigRequest req)` This API is used to query the task-related configurations of a whiteboard application, including the bucket and callback URL.
`DescribeWhiteboardBucketConfigResponse`	`DescribeWhiteboardBucketConfig(DescribeWhiteboardBucketConfigRequest req)` This API is used to query the bucket configurations for document transcoding and real-time recording.
`DescribeWhiteboardPushResponse`	`DescribeWhiteboardPush(DescribeWhiteboardPushRequest req)` This API is used to query the status and result of a whiteboard push task.
`DescribeWhiteboardPushCallbackResponse`	`DescribeWhiteboardPushCallback(DescribeWhiteboardPushCallbackRequest req)` This API is used to query the whiteboard push callback URL.
`DescribeWhiteboardPushSearchResponse`	`DescribeWhiteboardPushSearch(DescribeWhiteboardPushSearchRequest req)` This API is used to query whiteboard push tasks by room ID.
`ModifyApplicationResponse`	`ModifyApplication(ModifyApplicationRequest req)` This API is used to modify a whiteboard application.
`ModifyAutoRenewFlagResponse`	`ModifyAutoRenewFlag(ModifyAutoRenewFlagRequest req)` This API is used to set auto-renewal for a Tencent Interactive Whiteboard monthly feature package.
`ModifyWhiteboardApplicationConfigResponse`	`ModifyWhiteboardApplicationConfig(ModifyWhiteboardApplicationConfigRequest req)` This API is used to modify the task-related configurations of a whiteboard application, including the bucket and callback URL.
`ModifyWhiteboardBucketConfigResponse`	`ModifyWhiteboardBucketConfig(ModifyWhiteboardBucketConfigRequest req)` This API is used to modify the bucket configurations for document transcoding and real-time recording.
`PauseOnlineRecordResponse`	`PauseOnlineRecord(PauseOnlineRecordRequest req)` This API is used to pause real-time recording.
`ResumeOnlineRecordResponse`	`ResumeOnlineRecord(ResumeOnlineRecordRequest req)` This API is used to resume real-time recording.
`SetOnlineRecordCallbackResponse`	`SetOnlineRecordCallback(SetOnlineRecordCallbackRequest req)` This API is used to set the real-time recording callback address.
`SetOnlineRecordCallbackKeyResponse`	`SetOnlineRecordCallbackKey(SetOnlineRecordCallbackKeyRequest req)` This API is used to set the callback authentication key for real-time recording.
`SetTranscodeCallbackResponse`	`SetTranscodeCallback(SetTranscodeCallbackRequest req)` This API is used to set the callback address for document transcoding.
`SetTranscodeCallbackKeyResponse`	`SetTranscodeCallbackKey(SetTranscodeCallbackKeyRequest req)` This API is used to set the callback authentication key for document transcoding.
`SetVideoGenerationTaskCallbackResponse`	`SetVideoGenerationTaskCallback(SetVideoGenerationTaskCallbackRequest req)` This API is used to set the callback URL for recording video generation.
`SetVideoGenerationTaskCallbackKeyResponse`	`SetVideoGenerationTaskCallbackKey(SetVideoGenerationTaskCallbackKeyRequest req)` This API is used to set the callback authentication key for recording video generation.
`SetWhiteboardPushCallbackResponse`	`SetWhiteboardPushCallback(SetWhiteboardPushCallbackRequest req)` This API is used to set the whiteboard push callback URL.
`SetWhiteboardPushCallbackKeyResponse`	`SetWhiteboardPushCallbackKey(SetWhiteboardPushCallbackKeyRequest req)` This API is used to set the callback authentication key for whiteboard push.
`StartOnlineRecordResponse`	`StartOnlineRecord(StartOnlineRecordRequest req)` This API is used to start a real-time recording task.
`StartWhiteboardPushResponse`	`StartWhiteboardPush(StartWhiteboardPushRequest req)` This API is used to start a whiteboard push task.
`StopOnlineRecordResponse`	`StopOnlineRecord(StopOnlineRecordRequest req)` This API is used to stop real-time recording.
`StopWhiteboardPushResponse`	`StopWhiteboardPush(StopWhiteboardPushRequest req)` This API is used to stop a whiteboard push task.

Methods inherited from class com.tencentcloudapi.common.AbstractClient
call, callOctetStream, getClientProfile, getCredential, getRegion, getRegionBreaker, internalRequest, internalRequest, internalRequestRaw, processResponseJson, processResponseSSE, retry, setClientProfile, setCredential, setRegion, setRegionBreaker

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

- Constructor Detail
  - TiwClient
```
public TiwClient(Credential credential,
                 String region)
```
  - TiwClient
```
public TiwClient(Credential credential,
                 String region,
                 ClientProfile profile)
```
- Method Detail
  - ApplyTiwTrial
```
public ApplyTiwTrialResponse ApplyTiwTrial(ApplyTiwTrialRequest req)
                                    throws TencentCloudSDKException
```
    This API is used to apply for a Tencent Interactive Whiteboard trial (15-day by default).
    
    Parameters:
    
    req - ApplyTiwTrialRequest
    
    Returns:
    
    ApplyTiwTrialResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateApplication
```
public CreateApplicationResponse CreateApplication(CreateApplicationRequest req)
                                            throws TencentCloudSDKException
```
    This API is used to create a whiteboard application.
    
    Parameters:
    
    req - CreateApplicationRequest
    
    Returns:
    
    CreateApplicationResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateSnapshotTask
```
public CreateSnapshotTaskResponse CreateSnapshotTask(CreateSnapshotTaskRequest req)
                                              throws TencentCloudSDKException
```
    This API is used to create a whiteboard snapshot task. If a callback URL is provided, the whiteboard snapshot result is sent to the callback URL after the task is complete.
    
    Parameters:
    
    req - CreateSnapshotTaskRequest
    
    Returns:
    
    CreateSnapshotTaskResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateTranscode
```
public CreateTranscodeResponse CreateTranscode(CreateTranscodeRequest req)
                                        throws TencentCloudSDKException
```
    This API is used to create a document transcoding task.
    
    Parameters:
    
    req - CreateTranscodeRequest
    
    Returns:
    
    CreateTranscodeResponse
    
    Throws:
    
    TencentCloudSDKException
  - CreateVideoGenerationTask
```
public CreateVideoGenerationTaskResponse CreateVideoGenerationTask(CreateVideoGenerationTaskRequest req)
                                                            throws TencentCloudSDKException
```
    This API is used to create a recording video generation task.
    
    Parameters:
    
    req - CreateVideoGenerationTaskRequest
    
    Returns:
    
    CreateVideoGenerationTaskResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeAPIService
```
public DescribeAPIServiceResponse DescribeAPIService(DescribeAPIServiceRequest req)
                                              throws TencentCloudSDKException
```
    This API is used to query the information about other cloud products by using the service role.
    
    Parameters:
    
    req - DescribeAPIServiceRequest
    
    Returns:
    
    DescribeAPIServiceResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeApplicationInfos
```
public DescribeApplicationInfosResponse DescribeApplicationInfos(DescribeApplicationInfosRequest req)
                                                          throws TencentCloudSDKException
```
    This API is used to query the details of a whiteboard application.
    
    Parameters:
    
    req - DescribeApplicationInfosRequest
    
    Returns:
    
    DescribeApplicationInfosResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeApplicationUsage
```
public DescribeApplicationUsageResponse DescribeApplicationUsage(DescribeApplicationUsageRequest req)
                                                          throws TencentCloudSDKException
```
    This API is used to query the subproduct usage of Tencent Interactive Whiteboard.
    
    Parameters:
    
    req - DescribeApplicationUsageRequest
    
    Returns:
    
    DescribeApplicationUsageResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeBoardSDKLog
```
public DescribeBoardSDKLogResponse DescribeBoardSDKLog(DescribeBoardSDKLogRequest req)
                                                throws TencentCloudSDKException
```
    This API is used to query the logs of a whiteboard application on a client.
    
    Parameters:
    
    req - DescribeBoardSDKLogRequest
    
    Returns:
    
    DescribeBoardSDKLogResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeIMApplications
```
public DescribeIMApplicationsResponse DescribeIMApplications(DescribeIMApplicationsRequest req)
                                                      throws TencentCloudSDKException
```
    This API is used to query the instant messaging (IM) applications that are available for creating a whiteboard application.
    
    Parameters:
    
    req - DescribeIMApplicationsRequest
    
    Returns:
    
    DescribeIMApplicationsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeOnlineRecord
```
public DescribeOnlineRecordResponse DescribeOnlineRecord(DescribeOnlineRecordRequest req)
                                                  throws TencentCloudSDKException
```
    This API is used to query the status and result of a real-time recording task.
    
    Parameters:
    
    req - DescribeOnlineRecordRequest
    
    Returns:
    
    DescribeOnlineRecordResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeOnlineRecordCallback
```
public DescribeOnlineRecordCallbackResponse DescribeOnlineRecordCallback(DescribeOnlineRecordCallbackRequest req)
                                                                  throws TencentCloudSDKException
```
    This API is used to query the real-time recording callback address.
    
    Parameters:
    
    req - DescribeOnlineRecordCallbackRequest
    
    Returns:
    
    DescribeOnlineRecordCallbackResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribePostpaidUsage
```
public DescribePostpaidUsageResponse DescribePostpaidUsage(DescribePostpaidUsageRequest req)
                                                    throws TencentCloudSDKException
```
    This API is used to query the pay-as-you-go usage of a user.
    
    Parameters:
    
    req - DescribePostpaidUsageRequest
    
    Returns:
    
    DescribePostpaidUsageResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeQualityMetrics
```
public DescribeQualityMetricsResponse DescribeQualityMetrics(DescribeQualityMetricsRequest req)
                                                      throws TencentCloudSDKException
```
    This API is used to query the quality data of a whiteboard application.
    
    Parameters:
    
    req - DescribeQualityMetricsRequest
    
    Returns:
    
    DescribeQualityMetricsResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeRecordSearch
```
public DescribeRecordSearchResponse DescribeRecordSearch(DescribeRecordSearchRequest req)
                                                  throws TencentCloudSDKException
```
    This API is used to query real-time recording tasks by room ID.
    
    Parameters:
    
    req - DescribeRecordSearchRequest
    
    Returns:
    
    DescribeRecordSearchResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeRoomList
```
public DescribeRoomListResponse DescribeRoomList(DescribeRoomListRequest req)
                                          throws TencentCloudSDKException
```
    This API is used to query the rooms of a whiteboard application.
    
    Parameters:
    
    req - DescribeRoomListRequest
    
    Returns:
    
    DescribeRoomListResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeSnapshotTask
```
public DescribeSnapshotTaskResponse DescribeSnapshotTask(DescribeSnapshotTaskRequest req)
                                                  throws TencentCloudSDKException
```
    This API is used to query the information about a whiteboard snapshot task.
    
    Parameters:
    
    req - DescribeSnapshotTaskRequest
    
    Returns:
    
    DescribeSnapshotTaskResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeTIWDailyUsage
```
public DescribeTIWDailyUsageResponse DescribeTIWDailyUsage(DescribeTIWDailyUsageRequest req)
                                                    throws TencentCloudSDKException
```
    This API is used to query the daily billable usage of a whiteboard application. 1. The period queried per request cannot be longer than 31 days. 2. Due to statistics delays and other reasons, you cannot query the usage data of the current day. You can query today's usage after 7:00 tomorrow.
    
    Parameters:
    
    req - DescribeTIWDailyUsageRequest
    
    Returns:
    
    DescribeTIWDailyUsageResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeTIWRoomDailyUsage
```
public DescribeTIWRoomDailyUsageResponse DescribeTIWRoomDailyUsage(DescribeTIWRoomDailyUsageRequest req)
                                                            throws TencentCloudSDKException
```
    This API is used to query the daily billable usage by each room of a whiteboard application. 1. The period queried per request cannot be longer than 31 days. 2. Due to statistics delays and other reasons, you cannot query the usage data of the current day. You can query today's usage after 7:00 tomorrow.
    
    Parameters:
    
    req - DescribeTIWRoomDailyUsageRequest
    
    Returns:
    
    DescribeTIWRoomDailyUsageResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeTranscode
```
public DescribeTranscodeResponse DescribeTranscode(DescribeTranscodeRequest req)
                                            throws TencentCloudSDKException
```
    This API is used to query the progress and result of a document transcoding task.
    
    Parameters:
    
    req - DescribeTranscodeRequest
    
    Returns:
    
    DescribeTranscodeResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeTranscodeCallback
```
public DescribeTranscodeCallbackResponse DescribeTranscodeCallback(DescribeTranscodeCallbackRequest req)
                                                            throws TencentCloudSDKException
```
    This API is used to query the document transcoding callback address.
    
    Parameters:
    
    req - DescribeTranscodeCallbackRequest
    
    Returns:
    
    DescribeTranscodeCallbackResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeTranscodeSearch
```
public DescribeTranscodeSearchResponse DescribeTranscodeSearch(DescribeTranscodeSearchRequest req)
                                                        throws TencentCloudSDKException
```
    This API is used to query transcoding tasks by document name.
    
    Parameters:
    
    req - DescribeTranscodeSearchRequest
    
    Returns:
    
    DescribeTranscodeSearchResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeUsageSummary
```
public DescribeUsageSummaryResponse DescribeUsageSummary(DescribeUsageSummaryRequest req)
                                                  throws TencentCloudSDKException
```
    This API is used to query the summary of subproduct usage within a specified period of time.
    
    Parameters:
    
    req - DescribeUsageSummaryRequest
    
    Returns:
    
    DescribeUsageSummaryResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeUserList
```
public DescribeUserListResponse DescribeUserList(DescribeUserListRequest req)
                                          throws TencentCloudSDKException
```
    This API is used to query the users of a whiteboard application.
    
    Parameters:
    
    req - DescribeUserListRequest
    
    Returns:
    
    DescribeUserListResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeUserResources
```
public DescribeUserResourcesResponse DescribeUserResources(DescribeUserResourcesRequest req)
                                                    throws TencentCloudSDKException
```
    This API is used to query user resources.
    
    Parameters:
    
    req - DescribeUserResourcesRequest
    
    Returns:
    
    DescribeUserResourcesResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeUserStatus
```
public DescribeUserStatusResponse DescribeUserStatus(DescribeUserStatusRequest req)
                                              throws TencentCloudSDKException
```
    This API is used to query the Tencent Interactive Whiteboard service status of a user, including the activation status and validity period.
    
    Parameters:
    
    req - DescribeUserStatusRequest
    
    Returns:
    
    DescribeUserStatusResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeVideoGenerationTask
```
public DescribeVideoGenerationTaskResponse DescribeVideoGenerationTask(DescribeVideoGenerationTaskRequest req)
                                                                throws TencentCloudSDKException
```
    This API is used to query the status and result of a recording video generation task.
    
    Parameters:
    
    req - DescribeVideoGenerationTaskRequest
    
    Returns:
    
    DescribeVideoGenerationTaskResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeVideoGenerationTaskCallback
```
public DescribeVideoGenerationTaskCallbackResponse DescribeVideoGenerationTaskCallback(DescribeVideoGenerationTaskCallbackRequest req)
                                                                                throws TencentCloudSDKException
```
    This API is used to query the callback URL for recording video generation.
    
    Parameters:
    
    req - DescribeVideoGenerationTaskCallbackRequest
    
    Returns:
    
    DescribeVideoGenerationTaskCallbackResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeWhiteboardApplicationConfig
```
public DescribeWhiteboardApplicationConfigResponse DescribeWhiteboardApplicationConfig(DescribeWhiteboardApplicationConfigRequest req)
                                                                                throws TencentCloudSDKException
```
    This API is used to query the task-related configurations of a whiteboard application, including the bucket and callback URL.
    
    Parameters:
    
    req - DescribeWhiteboardApplicationConfigRequest
    
    Returns:
    
    DescribeWhiteboardApplicationConfigResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeWhiteboardBucketConfig
```
public DescribeWhiteboardBucketConfigResponse DescribeWhiteboardBucketConfig(DescribeWhiteboardBucketConfigRequest req)
                                                                      throws TencentCloudSDKException
```
    This API is used to query the bucket configurations for document transcoding and real-time recording.
    
    Parameters:
    
    req - DescribeWhiteboardBucketConfigRequest
    
    Returns:
    
    DescribeWhiteboardBucketConfigResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeWhiteboardPush
```
public DescribeWhiteboardPushResponse DescribeWhiteboardPush(DescribeWhiteboardPushRequest req)
                                                      throws TencentCloudSDKException
```
    This API is used to query the status and result of a whiteboard push task.
    
    Parameters:
    
    req - DescribeWhiteboardPushRequest
    
    Returns:
    
    DescribeWhiteboardPushResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeWhiteboardPushCallback
```
public DescribeWhiteboardPushCallbackResponse DescribeWhiteboardPushCallback(DescribeWhiteboardPushCallbackRequest req)
                                                                      throws TencentCloudSDKException
```
    This API is used to query the whiteboard push callback URL.
    
    Parameters:
    
    req - DescribeWhiteboardPushCallbackRequest
    
    Returns:
    
    DescribeWhiteboardPushCallbackResponse
    
    Throws:
    
    TencentCloudSDKException
  - DescribeWhiteboardPushSearch
```
public DescribeWhiteboardPushSearchResponse DescribeWhiteboardPushSearch(DescribeWhiteboardPushSearchRequest req)
                                                                  throws TencentCloudSDKException
```
    This API is used to query whiteboard push tasks by room ID.
    
    Parameters:
    
    req - DescribeWhiteboardPushSearchRequest
    
    Returns:
    
    DescribeWhiteboardPushSearchResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyApplication
```
public ModifyApplicationResponse ModifyApplication(ModifyApplicationRequest req)
                                            throws TencentCloudSDKException
```
    This API is used to modify a whiteboard application.
    
    Parameters:
    
    req - ModifyApplicationRequest
    
    Returns:
    
    ModifyApplicationResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyAutoRenewFlag
```
public ModifyAutoRenewFlagResponse ModifyAutoRenewFlag(ModifyAutoRenewFlagRequest req)
                                                throws TencentCloudSDKException
```
    This API is used to set auto-renewal for a Tencent Interactive Whiteboard monthly feature package.
    
    Parameters:
    
    req - ModifyAutoRenewFlagRequest
    
    Returns:
    
    ModifyAutoRenewFlagResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyWhiteboardApplicationConfig
```
public ModifyWhiteboardApplicationConfigResponse ModifyWhiteboardApplicationConfig(ModifyWhiteboardApplicationConfigRequest req)
                                                                            throws TencentCloudSDKException
```
    This API is used to modify the task-related configurations of a whiteboard application, including the bucket and callback URL.
    
    Parameters:
    
    req - ModifyWhiteboardApplicationConfigRequest
    
    Returns:
    
    ModifyWhiteboardApplicationConfigResponse
    
    Throws:
    
    TencentCloudSDKException
  - ModifyWhiteboardBucketConfig
```
public ModifyWhiteboardBucketConfigResponse ModifyWhiteboardBucketConfig(ModifyWhiteboardBucketConfigRequest req)
                                                                  throws TencentCloudSDKException
```
    This API is used to modify the bucket configurations for document transcoding and real-time recording.
    
    Parameters:
    
    req - ModifyWhiteboardBucketConfigRequest
    
    Returns:
    
    ModifyWhiteboardBucketConfigResponse
    
    Throws:
    
    TencentCloudSDKException
  - PauseOnlineRecord
```
public PauseOnlineRecordResponse PauseOnlineRecord(PauseOnlineRecordRequest req)
                                            throws TencentCloudSDKException
```
    This API is used to pause real-time recording.
    
    Parameters:
    
    req - PauseOnlineRecordRequest
    
    Returns:
    
    PauseOnlineRecordResponse
    
    Throws:
    
    TencentCloudSDKException
  - ResumeOnlineRecord
```
public ResumeOnlineRecordResponse ResumeOnlineRecord(ResumeOnlineRecordRequest req)
                                              throws TencentCloudSDKException
```
    This API is used to resume real-time recording.
    
    Parameters:
    
    req - ResumeOnlineRecordRequest
    
    Returns:
    
    ResumeOnlineRecordResponse
    
    Throws:
    
    TencentCloudSDKException
  - SetOnlineRecordCallback
```
public SetOnlineRecordCallbackResponse SetOnlineRecordCallback(SetOnlineRecordCallbackRequest req)
                                                        throws TencentCloudSDKException
```
    This API is used to set the real-time recording callback address. For the callback format, please [see here](https://www.tencentcloud.com/document/product/1176/55569).
    
    Parameters:
    
    req - SetOnlineRecordCallbackRequest
    
    Returns:
    
    SetOnlineRecordCallbackResponse
    
    Throws:
    
    TencentCloudSDKException
  - SetOnlineRecordCallbackKey
```
public SetOnlineRecordCallbackKeyResponse SetOnlineRecordCallbackKey(SetOnlineRecordCallbackKeyRequest req)
                                                              throws TencentCloudSDKException
```
    This API is used to set the callback authentication key for real-time recording. For more information, see [Event Notification](https://www.tencentcloud.com/document/product/1176/55569).
    
    Parameters:
    
    req - SetOnlineRecordCallbackKeyRequest
    
    Returns:
    
    SetOnlineRecordCallbackKeyResponse
    
    Throws:
    
    TencentCloudSDKException
  - SetTranscodeCallback
```
public SetTranscodeCallbackResponse SetTranscodeCallback(SetTranscodeCallbackRequest req)
                                                  throws TencentCloudSDKException
```
    This API is used to set the callback address for document transcoding. For the callback format, please [see here](https://www.tencentcloud.com/document/product/1176/55569).
    
    Parameters:
    
    req - SetTranscodeCallbackRequest
    
    Returns:
    
    SetTranscodeCallbackResponse
    
    Throws:
    
    TencentCloudSDKException
  - SetTranscodeCallbackKey
```
public SetTranscodeCallbackKeyResponse SetTranscodeCallbackKey(SetTranscodeCallbackKeyRequest req)
                                                        throws TencentCloudSDKException
```
    This API is used to set the callback authentication key for document transcoding. For more information, see [Event Notification](https://www.tencentcloud.com/document/product/1176/55569).
    
    Parameters:
    
    req - SetTranscodeCallbackKeyRequest
    
    Returns:
    
    SetTranscodeCallbackKeyResponse
    
    Throws:
    
    TencentCloudSDKException
  - SetVideoGenerationTaskCallback
```
public SetVideoGenerationTaskCallbackResponse SetVideoGenerationTaskCallback(SetVideoGenerationTaskCallbackRequest req)
                                                                      throws TencentCloudSDKException
```
    This API is used to set the callback URL for recording video generation.
    
    Parameters:
    
    req - SetVideoGenerationTaskCallbackRequest
    
    Returns:
    
    SetVideoGenerationTaskCallbackResponse
    
    Throws:
    
    TencentCloudSDKException
  - SetVideoGenerationTaskCallbackKey
```
public SetVideoGenerationTaskCallbackKeyResponse SetVideoGenerationTaskCallbackKey(SetVideoGenerationTaskCallbackKeyRequest req)
                                                                            throws TencentCloudSDKException
```
    This API is used to set the callback authentication key for recording video generation.
    
    Parameters:
    
    req - SetVideoGenerationTaskCallbackKeyRequest
    
    Returns:
    
    SetVideoGenerationTaskCallbackKeyResponse
    
    Throws:
    
    TencentCloudSDKException
  - SetWhiteboardPushCallback
```
public SetWhiteboardPushCallbackResponse SetWhiteboardPushCallback(SetWhiteboardPushCallbackRequest req)
                                                            throws TencentCloudSDKException
```
    This API is used to set the whiteboard push callback URL. For more information, see [Event Notification](https://www.tencentcloud.com/document/product/1176/55569).
    
    Parameters:
    
    req - SetWhiteboardPushCallbackRequest
    
    Returns:
    
    SetWhiteboardPushCallbackResponse
    
    Throws:
    
    TencentCloudSDKException
  - SetWhiteboardPushCallbackKey
```
public SetWhiteboardPushCallbackKeyResponse SetWhiteboardPushCallbackKey(SetWhiteboardPushCallbackKeyRequest req)
                                                                  throws TencentCloudSDKException
```
    This API is used to set the callback authentication key for whiteboard push. For more information, see [Event Notification](https://www.tencentcloud.com/document/product/1176/55569).
    
    Parameters:
    
    req - SetWhiteboardPushCallbackKeyRequest
    
    Returns:
    
    SetWhiteboardPushCallbackKeyResponse
    
    Throws:
    
    TencentCloudSDKException
  - StartOnlineRecord
```
public StartOnlineRecordResponse StartOnlineRecord(StartOnlineRecordRequest req)
                                            throws TencentCloudSDKException
```
    This API is used to start a real-time recording task.
    
    Parameters:
    
    req - StartOnlineRecordRequest
    
    Returns:
    
    StartOnlineRecordResponse
    
    Throws:
    
    TencentCloudSDKException
  - StartWhiteboardPush
```
public StartWhiteboardPushResponse StartWhiteboardPush(StartWhiteboardPushRequest req)
                                                throws TencentCloudSDKException
```
    This API is used to start a whiteboard push task.
    
    Parameters:
    
    req - StartWhiteboardPushRequest
    
    Returns:
    
    StartWhiteboardPushResponse
    
    Throws:
    
    TencentCloudSDKException
  - StopOnlineRecord
```
public StopOnlineRecordResponse StopOnlineRecord(StopOnlineRecordRequest req)
                                          throws TencentCloudSDKException
```
    This API is used to stop real-time recording.
    
    Parameters:
    
    req - StopOnlineRecordRequest
    
    Returns:
    
    StopOnlineRecordResponse
    
    Throws:
    
    TencentCloudSDKException
  - StopWhiteboardPush
```
public StopWhiteboardPushResponse StopWhiteboardPush(StopWhiteboardPushRequest req)
                                              throws TencentCloudSDKException
```
    This API is used to stop a whiteboard push task.
    
    Parameters:
    
    req - StopWhiteboardPushRequest
    
    Returns:
    
    StopWhiteboardPushResponse
    
    Throws:
    
    TencentCloudSDKException

Class TiwClient

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractClient

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractClient

Methods inherited from class java.lang.Object

Constructor Detail

TiwClient

TiwClient

Method Detail

ApplyTiwTrial

CreateApplication

CreateSnapshotTask

CreateTranscode

CreateVideoGenerationTask

DescribeAPIService

DescribeApplicationInfos

DescribeApplicationUsage

DescribeBoardSDKLog

DescribeIMApplications

DescribeOnlineRecord

DescribeOnlineRecordCallback

DescribePostpaidUsage

DescribeQualityMetrics

DescribeRecordSearch

DescribeRoomList

DescribeSnapshotTask

DescribeTIWDailyUsage

DescribeTIWRoomDailyUsage

DescribeTranscode

DescribeTranscodeCallback

DescribeTranscodeSearch

DescribeUsageSummary

DescribeUserList

DescribeUserResources

DescribeUserStatus

DescribeVideoGenerationTask

DescribeVideoGenerationTaskCallback

DescribeWhiteboardApplicationConfig

DescribeWhiteboardBucketConfig

DescribeWhiteboardPush

DescribeWhiteboardPushCallback

DescribeWhiteboardPushSearch

ModifyApplication

ModifyAutoRenewFlag

ModifyWhiteboardApplicationConfig

ModifyWhiteboardBucketConfig

PauseOnlineRecord

ResumeOnlineRecord

SetOnlineRecordCallback

SetOnlineRecordCallbackKey

SetTranscodeCallback

SetTranscodeCallbackKey

SetVideoGenerationTaskCallback

SetVideoGenerationTaskCallbackKey

SetWhiteboardPushCallback

SetWhiteboardPushCallbackKey

StartOnlineRecord

StartWhiteboardPush

StopOnlineRecord

StopWhiteboardPush