SignatureValidateRequest (alibaba-dingtalk-service-sdk 1.0.1 API)

java.lang.Object
- com.taobao.api.internal.sign.SignatureValidateRequest

所有已实现的接口:

TaobaoRequest<SignatureValidateResponse>, TaobaoUploadRequest<SignatureValidateResponse>
```
public class SignatureValidateRequest
extends Object
implements TaobaoUploadRequest<SignatureValidateResponse>
```
TOP API: taobao.signature.validate request

从以下版本开始:

1.0, 2015.09.10

作者:

auto create

构造器概要

构造器
构造器和说明

SignatureValidateRequest()

构造器
构造器和说明
`SignatureValidateRequest()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`check()` 客户端参数检查，减少服务端无效调用。
`String`	`getAlgorithm()`
`String`	`getApiMethodName()` 获取TOP的API名称。
`int`	`getBatchApiOrder()` 获取API在批量调用中的顺序，仅用于批量API调用请求。
`String`	`getBatchApiSession()` 获取API请求的用户授权码，仅用于批量API调用请求。
`FileItem`	`getBody()`
`String`	`getCharset()`
`Map<String,FileItem>`	`getFileParams()` 获取所有的Key-Value形式的文件请求参数集合。
`Map<String,String>`	`getHeaderMap()` 获取自定义HTTP请求头参数。
`String`	`getProxyAppKey()`
`Class<SignatureValidateResponse>`	`getResponseClass()` 获取具体响应实现类的定义。
`String`	`getSignature()`
`String`	`getTargetAppKey()` 获取被调用的目标AppKey
`Map<String,String>`	`getTextParams()` 获取所有的Key-Value形式的文本请求参数集合。
`Long`	`getTimestamp()` 获取请求时间戳（为空则用系统当前时间）
`String`	`getTopApiCallType()` 获取API调用方式
`String`	`getTopApiFormat()`
`String`	`getTopApiVersion()` API版本号，将作为最终API请求的v请求参数
`String`	`getTopContentType()` API对应的请求方式，包含xml,json,form
`String`	`getTopHttpMethod()` 获取Http method，例如GET,POST
`String`	`getTopResponseType()` API对应的响应格式，包含top(top标准),qimen(奇门1.0标准),qimen2(奇门2.0标准)
`void`	`putOtherTextParam(String key, String value)`
`void`	`setAlgorithm(String algorithm)`
`void`	`setBatchApiOrder(int order)` 设置API在批量调用中的顺序，仅用于批量API调用请求。
`void`	`setBatchApiSession(String session)` 设置API请求的用户授权码，仅用于批量API调用请求。
`void`	`setBody(FileItem body)`
`void`	`setCharset(String charset)`
`void`	`setProxyAppKey(String proxyAppKey)`
`void`	`setSignature(String signature)`
`void`	`setTimestamp(Long timestamp)`
`void`	`setTopApiCallType(String topApiCallType)`
`void`	`setTopApiFormat(String topApiFormat)`
`void`	`setTopApiVersion(String topApiVersion)`
`void`	`setTopContentType(String topContentType)`
`void`	`setTopHttpMethod(String topHttpMethod)`
`void`	`setTopResponseType(String topResponseType)`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - SignatureValidateRequest
```
public SignatureValidateRequest()
```
- 方法详细资料
  - setAlgorithm
```
public void setAlgorithm(String algorithm)
```
  - getAlgorithm
```
public String getAlgorithm()
```
  - setBody
```
public void setBody(FileItem body)
```
  - getBody
```
public FileItem getBody()
```
  - setCharset
```
public void setCharset(String charset)
```
  - getCharset
```
public String getCharset()
```
  - setProxyAppKey
```
public void setProxyAppKey(String proxyAppKey)
```
  - getProxyAppKey
```
public String getProxyAppKey()
```
  - setSignature
```
public void setSignature(String signature)
```
  - getSignature
```
public String getSignature()
```
  - getTimestamp
```
public Long getTimestamp()
```
    从接口复制的说明: TaobaoRequest
    
    获取请求时间戳（为空则用系统当前时间）
    
    指定者:
    
    getTimestamp 在接口中 TaobaoRequest<SignatureValidateResponse>
  - setTimestamp
```
public void setTimestamp(Long timestamp)
```
  - getApiMethodName
```
public String getApiMethodName()
```
    从接口复制的说明: TaobaoRequest
    
    获取TOP的API名称。
    
    指定者:
    
    getApiMethodName 在接口中 TaobaoRequest<SignatureValidateResponse>
    
    返回:
    
    API名称
  - getTopContentType
```
public String getTopContentType()
```
    从接口复制的说明: TaobaoRequest
    
    API对应的请求方式，包含xml,json,form
    
    指定者:
    
    getTopContentType 在接口中 TaobaoRequest<SignatureValidateResponse>
    
    返回:
  - setTopContentType
```
public void setTopContentType(String topContentType)
```
    指定者:
    
    setTopContentType 在接口中 TaobaoRequest<SignatureValidateResponse>
  - getTopResponseType
```
public String getTopResponseType()
```
    从接口复制的说明: TaobaoRequest
    
    API对应的响应格式，包含top(top标准),qimen(奇门1.0标准),qimen2(奇门2.0标准)
    
    指定者:
    
    getTopResponseType 在接口中 TaobaoRequest<SignatureValidateResponse>
    
    返回:
  - setTopResponseType
```
public void setTopResponseType(String topResponseType)
```
    指定者:
    
    setTopResponseType 在接口中 TaobaoRequest<SignatureValidateResponse>
  - getTopApiVersion
```
public String getTopApiVersion()
```
    从接口复制的说明: TaobaoRequest
    
    API版本号，将作为最终API请求的v请求参数
    
    指定者:
    
    getTopApiVersion 在接口中 TaobaoRequest<SignatureValidateResponse>
    
    返回:
  - setTopApiVersion
```
public void setTopApiVersion(String topApiVersion)
```
    指定者:
    
    setTopApiVersion 在接口中 TaobaoRequest<SignatureValidateResponse>
  - getTopApiFormat
```
public String getTopApiFormat()
```
    指定者:
    
    getTopApiFormat 在接口中 TaobaoRequest<SignatureValidateResponse>
  - setTopApiFormat
```
public void setTopApiFormat(String topApiFormat)
```
    指定者:
    
    setTopApiFormat 在接口中 TaobaoRequest<SignatureValidateResponse>
  - getTopApiCallType
```
public String getTopApiCallType()
```
    从接口复制的说明: TaobaoRequest
    
    获取API调用方式
    
    指定者:
    
    getTopApiCallType 在接口中 TaobaoRequest<SignatureValidateResponse>
    
    返回:
  - setTopApiCallType
```
public void setTopApiCallType(String topApiCallType)
```
    指定者:
    
    setTopApiCallType 在接口中 TaobaoRequest<SignatureValidateResponse>
  - getTopHttpMethod
```
public String getTopHttpMethod()
```
    从接口复制的说明: TaobaoRequest
    
    获取Http method，例如GET,POST
    
    指定者:
    
    getTopHttpMethod 在接口中 TaobaoRequest<SignatureValidateResponse>
    
    返回:
  - setTopHttpMethod
```
public void setTopHttpMethod(String topHttpMethod)
```
    指定者:
    
    setTopHttpMethod 在接口中 TaobaoRequest<SignatureValidateResponse>
  - getTextParams
```
public Map<String,String> getTextParams()
```
    从接口复制的说明: TaobaoRequest
    获取所有的Key-Value形式的文本请求参数集合。其中：
    - Key: 请求参数名
    - Value: 请求参数值
    指定者:
    
    getTextParams 在接口中 TaobaoRequest<SignatureValidateResponse>
    
    返回:
    
    文本请求参数集合
  - putOtherTextParam
```
public void putOtherTextParam(String key,
                              String value)
```
  - getFileParams
```
public Map<String,FileItem> getFileParams()
```
    从接口复制的说明: TaobaoUploadRequest
    获取所有的Key-Value形式的文件请求参数集合。其中：
    - Key: 请求参数名
    - Value: 请求参数文件元数据
    指定者:
    
    getFileParams 在接口中 TaobaoUploadRequest<SignatureValidateResponse>
    
    返回:
    
    文件请求参数集合
  - getResponseClass
```
public Class<SignatureValidateResponse> getResponseClass()
```
    从接口复制的说明: TaobaoRequest
    
    获取具体响应实现类的定义。
    
    指定者:
    
    getResponseClass 在接口中 TaobaoRequest<SignatureValidateResponse>
  - check
```
public void check()
           throws ApiRuleException
```
    从接口复制的说明: TaobaoRequest
    
    客户端参数检查，减少服务端无效调用。
    
    指定者:
    
    check 在接口中 TaobaoRequest<SignatureValidateResponse>
    
    抛出:
    
    ApiRuleException
  - getHeaderMap
```
public Map<String,String> getHeaderMap()
```
    从接口复制的说明: TaobaoRequest
    
    获取自定义HTTP请求头参数。
    
    指定者:
    
    getHeaderMap 在接口中 TaobaoRequest<SignatureValidateResponse>
  - getTargetAppKey
```
public String getTargetAppKey()
```
    从接口复制的说明: TaobaoRequest
    
    获取被调用的目标AppKey
    
    指定者:
    
    getTargetAppKey 在接口中 TaobaoRequest<SignatureValidateResponse>
  - getBatchApiSession
```
public String getBatchApiSession()
```
    从接口复制的说明: TaobaoRequest
    
    获取API请求的用户授权码，仅用于批量API调用请求。
    
    指定者:
    
    getBatchApiSession 在接口中 TaobaoRequest<SignatureValidateResponse>
    
    返回:
    
    用户授权码
  - setBatchApiSession
```
public void setBatchApiSession(String session)
```
    从接口复制的说明: TaobaoRequest
    
    设置API请求的用户授权码，仅用于批量API调用请求。
    
    指定者:
    
    setBatchApiSession 在接口中 TaobaoRequest<SignatureValidateResponse>
    
    参数:
    
    session - 用户授权码
  - getBatchApiOrder
```
public int getBatchApiOrder()
```
    从接口复制的说明: TaobaoRequest
    
    获取API在批量调用中的顺序，仅用于批量API调用请求。
    
    指定者:
    
    getBatchApiOrder 在接口中 TaobaoRequest<SignatureValidateResponse>
    
    返回:
    
    顺序值
  - setBatchApiOrder
```
public void setBatchApiOrder(int order)
```
    从接口复制的说明: TaobaoRequest
    
    设置API在批量调用中的顺序，仅用于批量API调用请求。
    
    指定者:
    
    setBatchApiOrder 在接口中 TaobaoRequest<SignatureValidateResponse>
    
    参数:
    
    order - 顺序值

类 SignatureValidateRequest

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

SignatureValidateRequest

方法详细资料

setAlgorithm

getAlgorithm

setBody

getBody

setCharset

getCharset

setProxyAppKey

getProxyAppKey

setSignature

getSignature

getTimestamp

setTimestamp

getApiMethodName

getTopContentType

setTopContentType

getTopResponseType

setTopResponseType

getTopApiVersion

setTopApiVersion

getTopApiFormat

setTopApiFormat

getTopApiCallType

setTopApiCallType

getTopHttpMethod

setTopHttpMethod

getTextParams

putOtherTextParam

getFileParams

getResponseClass

check

getHeaderMap

getTargetAppKey

getBatchApiSession

setBatchApiSession

getBatchApiOrder

setBatchApiOrder