DescribeCaptchaResultRequest (tencentcloud-sdk-java-intl-en 3.0.663 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractModel
- - com.tencentcloudapi.captcha.v20190722.models.DescribeCaptchaResultRequest

public class DescribeCaptchaResultRequest
extends AbstractModel

Constructor Summary

Constructors
Constructor and Description
`DescribeCaptchaResultRequest()`
`DescribeCaptchaResultRequest(DescribeCaptchaResultRequest 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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAppSecretKey()` Get CAPTCHA's app key.
`Long`	`getBusinessId()` Get Business ID, which is used to differentiate statistical data when this service is used in multiple businesses of a website or an app.
`Long`	`getCaptchaAppId()` Get CAPTCHA's app ID.
`Long`	`getCaptchaType()` Get It must be `9` here.
`String`	`getImei()` Get Mobile equipment identity number
`String`	`getMacAddress()` Get MAC address or unique identifier of a device
`Long`	`getNeedGetCaptchaTime()` Get Indicates whether to return the time when the frontend obtains the CAPTCHA.
`String`	`getRandstr()` Get A random string returned by the frontend callback function
`Long`	`getSceneId()` Get Scenario ID, which is used to differentiate statistical data when this service is used in multiple scenarios of a website or an app.
`String`	`getTicket()` Get The user verification ticket returned by the frontend callback function
`String`	`getUserIp()` Get The user public IP obtained from the customer backend server
`void`	`setAppSecretKey(String AppSecretKey)` Set CAPTCHA's app key.
`void`	`setBusinessId(Long BusinessId)` Set Business ID, which is used to differentiate statistical data when this service is used in multiple businesses of a website or an app.
`void`	`setCaptchaAppId(Long CaptchaAppId)` Set CAPTCHA's app ID.
`void`	`setCaptchaType(Long CaptchaType)` Set It must be `9` here.
`void`	`setImei(String Imei)` Set Mobile equipment identity number
`void`	`setMacAddress(String MacAddress)` Set MAC address or unique identifier of a device
`void`	`setNeedGetCaptchaTime(Long NeedGetCaptchaTime)` Set Indicates whether to return the time when the frontend obtains the CAPTCHA.
`void`	`setRandstr(String Randstr)` Set A random string returned by the frontend callback function
`void`	`setSceneId(Long SceneId)` Set Scenario ID, which is used to differentiate statistical data when this service is used in multiple scenarios of a website or an app.
`void`	`setTicket(String Ticket)` Set The user verification ticket returned by the frontend callback function
`void`	`setUserIp(String UserIp)` Set The user public IP obtained from the customer backend server
`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
  - DescribeCaptchaResultRequest
```
public DescribeCaptchaResultRequest()
```
  - DescribeCaptchaResultRequest
```
public DescribeCaptchaResultRequest(DescribeCaptchaResultRequest 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
  - getCaptchaType
```
public Long getCaptchaType()
```
    Get It must be `9` here. You can configure the CAPTCHA types in the console.
    
    Returns:
    
    CaptchaType It must be `9` here. You can configure the CAPTCHA types in the console.
  - setCaptchaType
```
public void setCaptchaType(Long CaptchaType)
```
    Set It must be `9` here. You can configure the CAPTCHA types in the console.
    
    Parameters:
    
    CaptchaType - It must be `9` here. You can configure the CAPTCHA types in the console.
  - getTicket
```
public String getTicket()
```
    Get The user verification ticket returned by the frontend callback function
    
    Returns:
    
    Ticket The user verification ticket returned by the frontend callback function
  - setTicket
```
public void setTicket(String Ticket)
```
    Set The user verification ticket returned by the frontend callback function
    
    Parameters:
    
    Ticket - The user verification ticket returned by the frontend callback function
  - getUserIp
```
public String getUserIp()
```
    Get The user public IP obtained from the customer backend server
    
    Returns:
    
    UserIp The user public IP obtained from the customer backend server
  - setUserIp
```
public void setUserIp(String UserIp)
```
    Set The user public IP obtained from the customer backend server
    
    Parameters:
    
    UserIp - The user public IP obtained from the customer backend server
  - getRandstr
```
public String getRandstr()
```
    Get A random string returned by the frontend callback function
    
    Returns:
    
    Randstr A random string returned by the frontend callback function
  - setRandstr
```
public void setRandstr(String Randstr)
```
    Set A random string returned by the frontend callback function
    
    Parameters:
    
    Randstr - A random string returned by the frontend callback function
  - getCaptchaAppId
```
public Long getCaptchaAppId()
```
    Get CAPTCHA's app ID. Log in to the [Captcha console](https://console.cloud.tencent.com/captcha/graphical) and you can view the CaptchaAppId in the "Key" column of the CAPTCHA list.
    
    Returns:
    
    CaptchaAppId CAPTCHA's app ID. Log in to the [Captcha console](https://console.cloud.tencent.com/captcha/graphical) and you can view the CaptchaAppId in the "Key" column of the CAPTCHA list.
  - setCaptchaAppId
```
public void setCaptchaAppId(Long CaptchaAppId)
```
    Set CAPTCHA's app ID. Log in to the [Captcha console](https://console.cloud.tencent.com/captcha/graphical) and you can view the CaptchaAppId in the "Key" column of the CAPTCHA list.
    
    Parameters:
    
    CaptchaAppId - CAPTCHA's app ID. Log in to the [Captcha console](https://console.cloud.tencent.com/captcha/graphical) and you can view the CaptchaAppId in the "Key" column of the CAPTCHA list.
  - getAppSecretKey
```
public String getAppSecretKey()
```
    Get CAPTCHA's app key. Log in to the [Captcha console](https://console.cloud.tencent.com/captcha/graphical) and you can view the AppSecretKey in the "Key" column of the CAPTCHA list. AppSecretKey is the key for CAPTCHA ticket verification performed by the server. Please keep it confidential and do not disclose it to any third parties.
    
    Returns:
    
    AppSecretKey CAPTCHA's app key. Log in to the [Captcha console](https://console.cloud.tencent.com/captcha/graphical) and you can view the AppSecretKey in the "Key" column of the CAPTCHA list. AppSecretKey is the key for CAPTCHA ticket verification performed by the server. Please keep it confidential and do not disclose it to any third parties.
  - setAppSecretKey
```
public void setAppSecretKey(String AppSecretKey)
```
    Set CAPTCHA's app key. Log in to the [Captcha console](https://console.cloud.tencent.com/captcha/graphical) and you can view the AppSecretKey in the "Key" column of the CAPTCHA list. AppSecretKey is the key for CAPTCHA ticket verification performed by the server. Please keep it confidential and do not disclose it to any third parties.
    
    Parameters:
    
    AppSecretKey - CAPTCHA's app key. Log in to the [Captcha console](https://console.cloud.tencent.com/captcha/graphical) and you can view the AppSecretKey in the "Key" column of the CAPTCHA list. AppSecretKey is the key for CAPTCHA ticket verification performed by the server. Please keep it confidential and do not disclose it to any third parties.
  - getBusinessId
```
public Long getBusinessId()
```
    Get Business ID, which is used to differentiate statistical data when this service is used in multiple businesses of a website or an app.
    
    Returns:
    
    BusinessId Business ID, which is used to differentiate statistical data when this service is used in multiple businesses of a website or an app.
  - setBusinessId
```
public void setBusinessId(Long BusinessId)
```
    Set Business ID, which is used to differentiate statistical data when this service is used in multiple businesses of a website or an app.
    
    Parameters:
    
    BusinessId - Business ID, which is used to differentiate statistical data when this service is used in multiple businesses of a website or an app.
  - getSceneId
```
public Long getSceneId()
```
    Get Scenario ID, which is used to differentiate statistical data when this service is used in multiple scenarios of a website or an app.
    
    Returns:
    
    SceneId Scenario ID, which is used to differentiate statistical data when this service is used in multiple scenarios of a website or an app.
  - setSceneId
```
public void setSceneId(Long SceneId)
```
    Set Scenario ID, which is used to differentiate statistical data when this service is used in multiple scenarios of a website or an app.
    
    Parameters:
    
    SceneId - Scenario ID, which is used to differentiate statistical data when this service is used in multiple scenarios of a website or an app.
  - getMacAddress
```
public String getMacAddress()
```
    Get MAC address or unique identifier of a device
    
    Returns:
    
    MacAddress MAC address or unique identifier of a device
  - setMacAddress
```
public void setMacAddress(String MacAddress)
```
    Set MAC address or unique identifier of a device
    
    Parameters:
    
    MacAddress - MAC address or unique identifier of a device
  - getImei
```
public String getImei()
```
    Get Mobile equipment identity number
    
    Returns:
    
    Imei Mobile equipment identity number
  - setImei
```
public void setImei(String Imei)
```
    Set Mobile equipment identity number
    
    Parameters:
    
    Imei - Mobile equipment identity number
  - getNeedGetCaptchaTime
```
public Long getNeedGetCaptchaTime()
```
    Get Indicates whether to return the time when the frontend obtains the CAPTCHA. Valid values: 1 (return the time) and others.
    
    Returns:
    
    NeedGetCaptchaTime Indicates whether to return the time when the frontend obtains the CAPTCHA. Valid values: 1 (return the time) and others.
  - setNeedGetCaptchaTime
```
public void setNeedGetCaptchaTime(Long NeedGetCaptchaTime)
```
    Set Indicates whether to return the time when the frontend obtains the CAPTCHA. Valid values: 1 (return the time) and others.
    
    Parameters:
    
    NeedGetCaptchaTime - Indicates whether to return the time when the frontend obtains the CAPTCHA. Valid values: 1 (return the time) and others.
  - toMap
```
public void toMap(HashMap<String,String> map,
                  String prefix)
```
    Internal implementation, normal users should not use it.
    
    Specified by:
    
    toMap in class AbstractModel

Class DescribeCaptchaResultRequest

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractModel

Methods inherited from class java.lang.Object

Constructor Detail

DescribeCaptchaResultRequest

DescribeCaptchaResultRequest

Method Detail

getCaptchaType

setCaptchaType

getTicket

setTicket

getUserIp

setUserIp

getRandstr

setRandstr

getCaptchaAppId

setCaptchaAppId

getAppSecretKey

setAppSecretKey

getBusinessId

setBusinessId

getSceneId

setSceneId

getMacAddress

setMacAddress

getImei

setImei

getNeedGetCaptchaTime

setNeedGetCaptchaTime

toMap