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()
HKIDCardOCRRequest(HKIDCardOCRRequest 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
Boolean	getDetectFake() Get Whether to check for authenticity.
String	getImageBase64() Get Base64 string of the image Supported image formats: PNG, JPG, JPEG.
String	getImageUrl() Get URL address of 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 string of the image Supported image formats: PNG, JPG, JPEG.
void	setImageUrl(String ImageUrl) Set URL address of 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()

HKIDCardOCRRequest

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

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 string of the image Supported image formats: PNG, JPG, JPEG. GIF is not supported yet. Supported image size: The downloaded image cannot exceed 7 MB after being Base64-encoded, and it cannot take longer than 3 seconds to download the image.

Returns:

ImageBase64 Base64 string of the image Supported image formats: PNG, JPG, JPEG. GIF is not supported yet. Supported image size: The downloaded image cannot exceed 7 MB after being Base64-encoded, and it cannot take longer than 3 seconds to download the image.

setImageBase64

public void setImageBase64(String ImageBase64)

Set Base64 string of the image Supported image formats: PNG, JPG, JPEG. GIF is not supported yet. Supported image size: The downloaded image cannot exceed 7 MB after being Base64-encoded, and it cannot take longer than 3 seconds to download the image.

Parameters:

ImageBase64 - Base64 string of the image Supported image formats: PNG, JPG, JPEG. GIF is not supported yet. Supported image size: The downloaded image cannot exceed 7 MB after being Base64-encoded, and it cannot take longer than 3 seconds to download the image.

getImageUrl

public String getImageUrl()

Get URL address of image. (This field is not supported outside Chinese mainland) Supported image formats: PNG, JPG, JPEG. GIF is currently not supported. Supported image size: the downloaded image cannot exceed 3 MB after being Base64-encoded. The download time of the image cannot exceed 3 seconds. We recommend you store 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 address of image. (This field is not supported outside Chinese mainland) Supported image formats: PNG, JPG, JPEG. GIF is currently not supported. Supported image size: the downloaded image cannot exceed 3 MB after being Base64-encoded. The download time of the image cannot exceed 3 seconds. We recommend you store 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 address of image. (This field is not supported outside Chinese mainland) Supported image formats: PNG, JPG, JPEG. GIF is currently not supported. Supported image size: the downloaded image cannot exceed 3 MB after being Base64-encoded. The download time of the image cannot exceed 3 seconds. We recommend you store 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 address of image. (This field is not supported outside Chinese mainland) Supported image formats: PNG, JPG, JPEG. GIF is currently not supported. Supported image size: the downloaded image cannot exceed 3 MB after being Base64-encoded. The download time of the image cannot exceed 3 seconds. We recommend you store 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