Package com.tencentcloudapi.tiw.v20190919.models

Class CreateSnapshotTaskRequest

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      String getCallbackURL()
      Get 白板板书生成结果通知回调地址
      SnapshotCOS getCOS()
      Get 白板板书文件 `COS` 存储参数， 不填默认存储在公共存储桶，公共存储桶的数据仅保存3天
      Long getRoomId()
      Get 白板房间号
      Long getSdkAppId()
      Get 白板房间 `SdkAppId`
      String getSnapshotMode()
      Get 白板板书生成模式，默认为 `AllMarks`。取值说明如下： `AllMarks` - 全量模式，即对于客户端每一次调用 `addSnapshotMark` 接口打上的白板板书生成标志全部都会生成对应的白板板书图片。 `LatestMarksOnly` - 单页去重模式，即对于客户端在同一页白板上多次调用 `addSnapshotMark` 打上的白板板书生成标志仅保留最新一次标志来生成对应白板页的白板板书图片。 （**注意：`LatestMarksOnly` 模式只有客户端使用v2.6.8及以上版本的白板SDK调用 `addSnapshotMark` 时才生效，否则即使在调用本API是指定了 `LatestMarksOnly` 模式，服务后台会使用默认的 `AllMarks` 模式生成白板板书**）
      SnapshotWhiteboard getWhiteboard()
      Get 白板相关参数
      void setCallbackURL​(String CallbackURL)
      Set 白板板书生成结果通知回调地址
      void setCOS​(SnapshotCOS COS)
      Set 白板板书文件 `COS` 存储参数， 不填默认存储在公共存储桶，公共存储桶的数据仅保存3天
      void setRoomId​(Long RoomId)
      Set 白板房间号
      void setSdkAppId​(Long SdkAppId)
      Set 白板房间 `SdkAppId`
      void setSnapshotMode​(String SnapshotMode)
      Set 白板板书生成模式，默认为 `AllMarks`。取值说明如下： `AllMarks` - 全量模式，即对于客户端每一次调用 `addSnapshotMark` 接口打上的白板板书生成标志全部都会生成对应的白板板书图片。 `LatestMarksOnly` - 单页去重模式，即对于客户端在同一页白板上多次调用 `addSnapshotMark` 打上的白板板书生成标志仅保留最新一次标志来生成对应白板页的白板板书图片。 （**注意：`LatestMarksOnly` 模式只有客户端使用v2.6.8及以上版本的白板SDK调用 `addSnapshotMark` 时才生效，否则即使在调用本API是指定了 `LatestMarksOnly` 模式，服务后台会使用默认的 `AllMarks` 模式生成白板板书**）
      void setWhiteboard​(SnapshotWhiteboard Whiteboard)
      Set 白板相关参数
      void toMap​(HashMap<String,​String> map, String prefix)
      Internal implementation, normal users should not use it.

    • 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 白板相关参数
        Returns:
        Whiteboard 白板相关参数

      • setWhiteboard

        public void setWhiteboard​(SnapshotWhiteboard Whiteboard)
        Set 白板相关参数
        Parameters:
        Whiteboard - 白板相关参数

      • getSdkAppId

        public Long getSdkAppId()
        Get 白板房间 `SdkAppId`
        Returns:
        SdkAppId 白板房间 `SdkAppId`

      • setSdkAppId

        public void setSdkAppId​(Long SdkAppId)
        Set 白板房间 `SdkAppId`
        Parameters:
        SdkAppId - 白板房间 `SdkAppId`

      • getRoomId

        public Long getRoomId()
        Get 白板房间号
        Returns:
        RoomId 白板房间号

      • setRoomId

        public void setRoomId​(Long RoomId)
        Set 白板房间号
        Parameters:
        RoomId - 白板房间号

      • getCallbackURL

        public String getCallbackURL()
        Get 白板板书生成结果通知回调地址
        Returns:
        CallbackURL 白板板书生成结果通知回调地址

      • setCallbackURL

        public void setCallbackURL​(String CallbackURL)
        Set 白板板书生成结果通知回调地址
        Parameters:
        CallbackURL - 白板板书生成结果通知回调地址

      • getCOS

        public SnapshotCOS getCOS()
        Get 白板板书文件 `COS` 存储参数， 不填默认存储在公共存储桶，公共存储桶的数据仅保存3天
        Returns:
        COS 白板板书文件 `COS` 存储参数， 不填默认存储在公共存储桶，公共存储桶的数据仅保存3天

      • setCOS

        public void setCOS​(SnapshotCOS COS)
        Set 白板板书文件 `COS` 存储参数， 不填默认存储在公共存储桶，公共存储桶的数据仅保存3天
        Parameters:
        COS - 白板板书文件 `COS` 存储参数， 不填默认存储在公共存储桶，公共存储桶的数据仅保存3天

      • getSnapshotMode

        public String getSnapshotMode()
        Get 白板板书生成模式，默认为 `AllMarks`。取值说明如下： `AllMarks` - 全量模式，即对于客户端每一次调用 `addSnapshotMark` 接口打上的白板板书生成标志全部都会生成对应的白板板书图片。 `LatestMarksOnly` - 单页去重模式，即对于客户端在同一页白板上多次调用 `addSnapshotMark` 打上的白板板书生成标志仅保留最新一次标志来生成对应白板页的白板板书图片。 （**注意：`LatestMarksOnly` 模式只有客户端使用v2.6.8及以上版本的白板SDK调用 `addSnapshotMark` 时才生效，否则即使在调用本API是指定了 `LatestMarksOnly` 模式，服务后台会使用默认的 `AllMarks` 模式生成白板板书**）
        Returns:
        SnapshotMode 白板板书生成模式，默认为 `AllMarks`。取值说明如下： `AllMarks` - 全量模式，即对于客户端每一次调用 `addSnapshotMark` 接口打上的白板板书生成标志全部都会生成对应的白板板书图片。 `LatestMarksOnly` - 单页去重模式，即对于客户端在同一页白板上多次调用 `addSnapshotMark` 打上的白板板书生成标志仅保留最新一次标志来生成对应白板页的白板板书图片。 （**注意：`LatestMarksOnly` 模式只有客户端使用v2.6.8及以上版本的白板SDK调用 `addSnapshotMark` 时才生效，否则即使在调用本API是指定了 `LatestMarksOnly` 模式，服务后台会使用默认的 `AllMarks` 模式生成白板板书**）

      • setSnapshotMode

        public void setSnapshotMode​(String SnapshotMode)
        Set 白板板书生成模式，默认为 `AllMarks`。取值说明如下： `AllMarks` - 全量模式，即对于客户端每一次调用 `addSnapshotMark` 接口打上的白板板书生成标志全部都会生成对应的白板板书图片。 `LatestMarksOnly` - 单页去重模式，即对于客户端在同一页白板上多次调用 `addSnapshotMark` 打上的白板板书生成标志仅保留最新一次标志来生成对应白板页的白板板书图片。 （**注意：`LatestMarksOnly` 模式只有客户端使用v2.6.8及以上版本的白板SDK调用 `addSnapshotMark` 时才生效，否则即使在调用本API是指定了 `LatestMarksOnly` 模式，服务后台会使用默认的 `AllMarks` 模式生成白板板书**）
        Parameters:
        SnapshotMode - 白板板书生成模式，默认为 `AllMarks`。取值说明如下： `AllMarks` - 全量模式，即对于客户端每一次调用 `addSnapshotMark` 接口打上的白板板书生成标志全部都会生成对应的白板板书图片。 `LatestMarksOnly` - 单页去重模式，即对于客户端在同一页白板上多次调用 `addSnapshotMark` 打上的白板板书生成标志仅保留最新一次标志来生成对应白板页的白板板书图片。 （**注意：`LatestMarksOnly` 模式只有客户端使用v2.6.8及以上版本的白板SDK调用 `addSnapshotMark` 时才生效，否则即使在调用本API是指定了 `LatestMarksOnly` 模式，服务后台会使用默认的 `AllMarks` 模式生成白板板书**）