com.dingtalk.api.request

Class OapiFileUploadSingleRequest

java.lang.Object

com.taobao.api.BaseTaobaoRequest<OapiFileUploadSingleResponse>

com.dingtalk.api.request.OapiFileUploadSingleRequest

All Implemented Interfaces:

TaobaoRequest<OapiFileUploadSingleResponse>, TaobaoUploadRequest<OapiFileUploadSingleResponse>

public class OapiFileUploadSingleRequest
extends BaseTaobaoRequest<OapiFileUploadSingleResponse>
implements TaobaoUploadRequest<OapiFileUploadSingleResponse>

TOP DingTalk-API: dingtalk.oapi.file.upload.single request

Since:

1.0, 2018.07.25

Author:

top auto create

Field Summary

Fields inherited from class com.taobao.api.BaseTaobaoRequest

headerMap, order, session, targetAppKey, timestamp, topMixParams, udfParams

Constructor Summary

Constructors

Constructor and Description
OapiFileUploadSingleRequest()

Method Summary

Modifier and Type	Method and Description
void	check() 客户端参数检查，减少服务端无效调用。
String	getAgentId()
String	getApiMethodName() 获取TOP的API名称。
FileItem	getFile()
Map<String,FileItem>	getFileParams() 获取所有的Key-Value形式的文件请求参数集合。其中： Key: 请求参数名 Value: 请求参数文件元数据
Long	getFileSize()
Class<OapiFileUploadSingleResponse>	getResponseClass() 获取具体响应实现类的定义。
Map<String,String>	getTextParams() 获取所有的Key-Value形式的文本请求参数集合。其中： Key: 请求参数名 Value: 请求参数值
String	getTopApiCallType() 获取API调用方式
String	getTopHttpMethod() 获取Http method，例如GET,POST
String	getTopResponseType() API对应的响应格式，包含top(top标准),qimen(奇门1.0标准),qimen2(奇门2.0标准)
void	setAgentId(String agentId)
void	setFile(FileItem file)
void	setFileSize(Long fileSize)
void	setTopResponseType(String topResponseType)

Methods inherited from class com.taobao.api.BaseTaobaoRequest

getBatchApiOrder, getBatchApiSession, getHeaderMap, getTargetAppKey, getTimestamp, getTopApiFormat, getTopApiVersion, getTopContentType, getTopMixParams, putHeaderParam, putOtherTextParam, setBatchApiOrder, setBatchApiSession, setHeaderMap, setTargetAppKey, setTimestamp, setTopApiCallType, setTopApiFormat, setTopApiVersion, setTopContentType, setTopHttpMethod, setTopMixParams

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.taobao.api.TaobaoRequest

getBatchApiOrder, getBatchApiSession, getHeaderMap, getTargetAppKey, getTimestamp, getTopApiFormat, getTopApiVersion, getTopContentType, setBatchApiOrder, setBatchApiSession, setTopApiCallType, setTopApiFormat, setTopApiVersion, setTopContentType, setTopHttpMethod

Constructor Detail

OapiFileUploadSingleRequest

public OapiFileUploadSingleRequest()

Method Detail

setAgentId

public void setAgentId(String agentId)

getAgentId

public String getAgentId()

setFile

public void setFile(FileItem file)

getFile

public FileItem getFile()

setFileSize

public void setFileSize(Long fileSize)

getFileSize

public Long getFileSize()

getApiMethodName

public String getApiMethodName()

Description copied from interface: TaobaoRequest

获取TOP的API名称。

Specified by:

getApiMethodName in interface TaobaoRequest<OapiFileUploadSingleResponse>

Overrides:

getApiMethodName in class BaseTaobaoRequest<OapiFileUploadSingleResponse>

Returns:

API名称

getTopResponseType

public String getTopResponseType()

Description copied from interface: TaobaoRequest

API对应的响应格式，包含top(top标准),qimen(奇门1.0标准),qimen2(奇门2.0标准)

Specified by:

getTopResponseType in interface TaobaoRequest<OapiFileUploadSingleResponse>

Overrides:

getTopResponseType in class BaseTaobaoRequest<OapiFileUploadSingleResponse>

Returns:

setTopResponseType

public void setTopResponseType(String topResponseType)

Specified by:

setTopResponseType in interface TaobaoRequest<OapiFileUploadSingleResponse>

Overrides:

setTopResponseType in class BaseTaobaoRequest<OapiFileUploadSingleResponse>

getTopApiCallType

public String getTopApiCallType()

Description copied from interface: TaobaoRequest

获取API调用方式

Specified by:

getTopApiCallType in interface TaobaoRequest<OapiFileUploadSingleResponse>

Overrides:

getTopApiCallType in class BaseTaobaoRequest<OapiFileUploadSingleResponse>

Returns:

getTopHttpMethod

public String getTopHttpMethod()

Description copied from interface: TaobaoRequest

获取Http method，例如GET,POST

Specified by:

getTopHttpMethod in interface TaobaoRequest<OapiFileUploadSingleResponse>

Overrides:

getTopHttpMethod in class BaseTaobaoRequest<OapiFileUploadSingleResponse>

Returns:

getTextParams

public Map<String,String> getTextParams()

Description copied from interface: TaobaoRequest

获取所有的Key-Value形式的文本请求参数集合。其中：

• Key: 请求参数名
• Value: 请求参数值

Specified by:

getTextParams in interface TaobaoRequest<OapiFileUploadSingleResponse>

Returns:

文本请求参数集合

getResponseClass

public Class<OapiFileUploadSingleResponse> getResponseClass()

Description copied from interface: TaobaoRequest

获取具体响应实现类的定义。

Specified by:

getResponseClass in interface TaobaoRequest<OapiFileUploadSingleResponse>

check

public void check()
           throws ApiRuleException

Description copied from interface: TaobaoRequest

客户端参数检查，减少服务端无效调用。

Specified by:

check in interface TaobaoRequest<OapiFileUploadSingleResponse>

Throws:

ApiRuleException

getFileParams

public Map<String,FileItem> getFileParams()

Description copied from interface: TaobaoUploadRequest

获取所有的Key-Value形式的文件请求参数集合。其中：

• Key: 请求参数名
• Value: 请求参数文件元数据

Specified by:

getFileParams in interface TaobaoUploadRequest<OapiFileUploadSingleResponse>

Returns:

文件请求参数集合