com.tencentcloudapi.tiw.v20190919.models

Class CreateSnapshotTaskRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.tiw.v20190919.models.CreateSnapshotTaskRequest

public class CreateSnapshotTaskRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
CreateSnapshotTaskRequest()
CreateSnapshotTaskRequest(CreateSnapshotTaskRequest 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
String	getCallbackURL() Get Callback URL to which the whiteboard snapshot result is to be sent.
SnapshotCOS	getCOS() Get `COS` bucket in which the generated whiteboard snapshot file is to be stored.
Long	getRoomId() Get Whiteboard room ID.
Long	getSdkAppId() Get `SdkAppId` of the whiteboard application.
String	getSnapshotMode() Get Whiteboard snapshot mode.
SnapshotWhiteboard	getWhiteboard() Get Whiteboard parameters.
void	setCallbackURL(String CallbackURL) Set Callback URL to which the whiteboard snapshot result is to be sent.
void	setCOS(SnapshotCOS COS) Set `COS` bucket in which the generated whiteboard snapshot file is to be stored.
void	setRoomId(Long RoomId) Set Whiteboard room ID.
void	setSdkAppId(Long SdkAppId) Set `SdkAppId` of the whiteboard application.
void	setSnapshotMode(String SnapshotMode) Set Whiteboard snapshot mode.
void	setWhiteboard(SnapshotWhiteboard Whiteboard) Set Whiteboard parameters.
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, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateSnapshotTaskRequest

public CreateSnapshotTaskRequest()

CreateSnapshotTaskRequest

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

getWhiteboard

public SnapshotWhiteboard getWhiteboard()

Get Whiteboard parameters.

Returns:

Whiteboard Whiteboard parameters.

setWhiteboard

public void setWhiteboard(SnapshotWhiteboard Whiteboard)

Set Whiteboard parameters.

Parameters:

Whiteboard - Whiteboard parameters.

getSdkAppId

public Long getSdkAppId()

Get `SdkAppId` of the whiteboard application.

Returns:

SdkAppId `SdkAppId` of the whiteboard application.

setSdkAppId

public void setSdkAppId(Long SdkAppId)

Set `SdkAppId` of the whiteboard application.

Parameters:

SdkAppId - `SdkAppId` of the whiteboard application.

getRoomId

public Long getRoomId()

Get Whiteboard room ID.

Returns:

RoomId Whiteboard room ID.

setRoomId

public void setRoomId(Long RoomId)

Set Whiteboard room ID.

Parameters:

RoomId - Whiteboard room ID.

getCallbackURL

public String getCallbackURL()

Get Callback URL to which the whiteboard snapshot result is to be sent.

Returns:

CallbackURL Callback URL to which the whiteboard snapshot result is to be sent.

setCallbackURL

public void setCallbackURL(String CallbackURL)

Set Callback URL to which the whiteboard snapshot result is to be sent.

Parameters:

CallbackURL - Callback URL to which the whiteboard snapshot result is to be sent.

getCOS

public SnapshotCOS getCOS()

Get `COS` bucket in which the generated whiteboard snapshot file is to be stored. If you leave this parameter empty, the generated file will be stored in the public bucket and retained for only three days.

Returns:

COS `COS` bucket in which the generated whiteboard snapshot file is to be stored. If you leave this parameter empty, the generated file will be stored in the public bucket and retained for only three days.

setCOS

public void setCOS(SnapshotCOS COS)

Set `COS` bucket in which the generated whiteboard snapshot file is to be stored. If you leave this parameter empty, the generated file will be stored in the public bucket and retained for only three days.

Parameters:

COS - `COS` bucket in which the generated whiteboard snapshot file is to be stored. If you leave this parameter empty, the generated file will be stored in the public bucket and retained for only three days.

getSnapshotMode

public String getSnapshotMode()

Get Whiteboard snapshot mode. Default value: `AllMarks`. Valid values: `AllMarks`: Full mode. In this mode, a snapshot image is generated based on each whiteboard snapshot mark that is added by calling the `addSnapshotMark` API on the client. `LatestMarksOnly`: Single-page deduplication mode. In this mode, a snapshot image is generated based only on the latest whiteboard snapshot mark that is added by calling the `addSnapshotMark` API on the client if the API is called multiple times for the same whiteboard snapshot. Note: The `LatestMarksOnly` mode takes effect only when the `addSnapshotMark` API is called by using Tencent Interactive Whiteboard SDK v2.6.8 or later. Otherwise, even if this parameter is set to `LatestMarksOnly`, the default `AllMarks` mode is used.**

Returns:

SnapshotMode Whiteboard snapshot mode. Default value: `AllMarks`. Valid values: `AllMarks`: Full mode. In this mode, a snapshot image is generated based on each whiteboard snapshot mark that is added by calling the `addSnapshotMark` API on the client. `LatestMarksOnly`: Single-page deduplication mode. In this mode, a snapshot image is generated based only on the latest whiteboard snapshot mark that is added by calling the `addSnapshotMark` API on the client if the API is called multiple times for the same whiteboard snapshot. Note: The `LatestMarksOnly` mode takes effect only when the `addSnapshotMark` API is called by using Tencent Interactive Whiteboard SDK v2.6.8 or later. Otherwise, even if this parameter is set to `LatestMarksOnly`, the default `AllMarks` mode is used.**

setSnapshotMode

public void setSnapshotMode(String SnapshotMode)

Set Whiteboard snapshot mode. Default value: `AllMarks`. Valid values: `AllMarks`: Full mode. In this mode, a snapshot image is generated based on each whiteboard snapshot mark that is added by calling the `addSnapshotMark` API on the client. `LatestMarksOnly`: Single-page deduplication mode. In this mode, a snapshot image is generated based only on the latest whiteboard snapshot mark that is added by calling the `addSnapshotMark` API on the client if the API is called multiple times for the same whiteboard snapshot. Note: The `LatestMarksOnly` mode takes effect only when the `addSnapshotMark` API is called by using Tencent Interactive Whiteboard SDK v2.6.8 or later. Otherwise, even if this parameter is set to `LatestMarksOnly`, the default `AllMarks` mode is used.**

Parameters:

SnapshotMode - Whiteboard snapshot mode. Default value: `AllMarks`. Valid values: `AllMarks`: Full mode. In this mode, a snapshot image is generated based on each whiteboard snapshot mark that is added by calling the `addSnapshotMark` API on the client. `LatestMarksOnly`: Single-page deduplication mode. In this mode, a snapshot image is generated based only on the latest whiteboard snapshot mark that is added by calling the `addSnapshotMark` API on the client if the API is called multiple times for the same whiteboard snapshot. Note: The `LatestMarksOnly` mode takes effect only when the `addSnapshotMark` API is called by using Tencent Interactive Whiteboard SDK v2.6.8 or later. Otherwise, even if this parameter is set to `LatestMarksOnly`, the default `AllMarks` mode is used.**

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel