com.tencentcloudapi.ocr.v20181119.models

Class HKIDCardOCRRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.ocr.v20181119.models.HKIDCardOCRRequest

public class HKIDCardOCRRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
HKIDCardOCRRequest()

Method Summary

Modifier and Type	Method and Description
Boolean	getDetectFake() Get Whether to check for authenticity.
String	getImageBase64() Get Base64-encoded value of image.
String	getImageUrl() Get URL of the image.
Boolean	getReturnHeadImage() Get Whether to return identity photo.
void	setDetectFake(Boolean DetectFake) Set Whether to check for authenticity.
void	setImageBase64(String ImageBase64) Set Base64-encoded value of image.
void	setImageUrl(String ImageUrl) Set URL of the image.
void	setReturnHeadImage(Boolean ReturnHeadImage) Set Whether to return identity photo.
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

HKIDCardOCRRequest

public HKIDCardOCRRequest()

Method Detail

getDetectFake

public Boolean getDetectFake()

Get Whether to check for authenticity.

Returns:

DetectFake Whether to check for authenticity.

setDetectFake

public void setDetectFake(Boolean DetectFake)

Set Whether to check for authenticity.

Parameters:

DetectFake - Whether to check for authenticity.

getReturnHeadImage

public Boolean getReturnHeadImage()

Get Whether to return identity photo.

Returns:

ReturnHeadImage Whether to return identity photo.

setReturnHeadImage

public void setReturnHeadImage(Boolean ReturnHeadImage)

Set Whether to return identity photo.

Parameters:

ReturnHeadImage - Whether to return identity photo.

getImageBase64

public String getImageBase64()

Get Base64-encoded value of image. Supported image formats: PNG, JPG, JPEG. GIF is currently not supported. Supported image size: the downloaded image cannot exceed 3 MB in size after being Base64-encoded. The download time of the image cannot exceed 3 seconds.

Returns:

ImageBase64 Base64-encoded value of image. Supported image formats: PNG, JPG, JPEG. GIF is currently not supported. Supported image size: the downloaded image cannot exceed 3 MB in size after being Base64-encoded. The download time of the image cannot exceed 3 seconds.

setImageBase64

public void setImageBase64(String ImageBase64)

Set Base64-encoded value of image. Supported image formats: PNG, JPG, JPEG. GIF is currently not supported. Supported image size: the downloaded image cannot exceed 3 MB in size after being Base64-encoded. The download time of the image cannot exceed 3 seconds.

Parameters:

ImageBase64 - Base64-encoded value of image. Supported image formats: PNG, JPG, JPEG. GIF is currently not supported. Supported image size: the downloaded image cannot exceed 3 MB in size after being Base64-encoded. The download time of the image cannot exceed 3 seconds.

getImageUrl

public String getImageUrl()

Get URL of the image. Supported image formats: PNG, JPG, JPEG. GIF is currently not supported. Supported image size: the downloaded image cannot exceed 3 MB in size after being Base64-encoded. The download time of the image cannot exceed 3 seconds. We recommend storing the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability. The download speed and stability of non-Tencent Cloud URLs may be low.

Returns:

ImageUrl URL of the image. Supported image formats: PNG, JPG, JPEG. GIF is currently not supported. Supported image size: the downloaded image cannot exceed 3 MB in size after being Base64-encoded. The download time of the image cannot exceed 3 seconds. We recommend storing the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability. The download speed and stability of non-Tencent Cloud URLs may be low.

setImageUrl

public void setImageUrl(String ImageUrl)

Set URL of the image. Supported image formats: PNG, JPG, JPEG. GIF is currently not supported. Supported image size: the downloaded image cannot exceed 3 MB in size after being Base64-encoded. The download time of the image cannot exceed 3 seconds. We recommend storing the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability. The download speed and stability of non-Tencent Cloud URLs may be low.

Parameters:

ImageUrl - URL of the image. Supported image formats: PNG, JPG, JPEG. GIF is currently not supported. Supported image size: the downloaded image cannot exceed 3 MB in size after being Base64-encoded. The download time of the image cannot exceed 3 seconds. We recommend storing the image in Tencent Cloud, as a Tencent Cloud URL can guarantee higher download speed and stability. The download speed and stability of non-Tencent Cloud URLs may be low.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel