BDImageXUploaderClient class
- Inheritance
-
- Object
- NativeClass
- BDImageXUploaderClient
Methods
-
close()
→ FutureOr<void>
-
{zh}
@brief 结束上传，并销毁上传实例（不可恢复）。
@notes 当不需要再次进行上传操作时，务必调用该函数进行上传实例的销毁，否则会导致内存泄露。
-
destroy()
→ void
-
inherited
-
initWithFilePaths(NSArray<NSString> filePaths)
→ FutureOr<BDImageXUploaderClient>
-
{zh}
@brief 初始化上传实例。
@param filePaths 需要上传的图片的路径。
@return 上传实例。
-
nativeCall<T>(String method, [List? args, NativeMethodMeta? meta])
→ Future<T>
-
Call instance method
inherited
-
noSuchMethod(Invocation invocation)
→ dynamic
-
Invoked when a nonexistent method or property is accessed.
inherited
-
sendInstanceGet<T>(String property)
→ Future<T>
-
Get instance property
inherited
-
sendInstanceSet(String property, dynamic value)
→ Future<void>
-
Set instance property
inherited
-
setAuthorizationParameter(NSDictionary parameter)
→ FutureOr<void>
-
{zh}
@brief 设置鉴权。
@param parameter 鉴权参数。
@brief 鉴权参数包括：
BDFileUploadAccessKey : accessKey
BDFileUploadSecretKey : secretKey
BDFileUploadSessionToken : sessionToken
BDFileUploadServiceID : serviceId
-
{zh}
@brief 设置自定义 http header。
@param parameter 需要设置的 header。
-
setE2EEncInfoDict(NSDictionary info)
→ FutureOr<void>
-
{zh}
@brief 设置加密上传所用参数。
@param info 加密上传所用到的参数
@notes 参数详情：
BDFileUploadE2EEncOption: 是否开启加密，@(0)代表不加密，@(1)代表加密；
BDFileUploadE2EEncPublicKey: 设置 RSA 公钥;
BDFileUploadE2EEncAESKey: 设置 AES 密钥;
不设置 AES 密钥，则 SDK 会自动生成，并在上传成功后经回调返回具体内容；如果需要自定义密钥内容，需为 32 位字符串，并经 base64 编码之后传入。
-
setEnableExternDNS(BOOL isEnableExternDNS)
→ FutureOr<void>
-
{zh}
@brief 开启额外 dns 解析功能。
@param isEnableExternDNS 是否开启该功能。
-
setEnableHttpDnsRetry(BOOL enableHttpDnsRetry)
→ FutureOr<void>
-
{zh}
@brief 开启 httpdns 重试功能。
@param enableHttpDnsRetry 是否开启该功能。
-
setEnableMd5StoreKey(BOOL enable)
→ FutureOr<void>
-
{zh}
@brief 开启计算文件的 md5 值作为文件的存储 key。
@param enable 是否开启该功能。
-
setEnableOverwrite(BOOL enable)
→ FutureOr<void>
-
{zh}
@brief 开启存储 key 相同的文件覆盖上传。
@param enable 是否开启该功能。
-
setFileExtension(NSString fileExtension)
→ FutureOr<void>
-
{zh}
@brief 设置文件后缀。
@param fileExtension 需要设置的文件后缀。
@notes 后缀需要以 '.' 开头，比如 ".jpg"。
-
setFilePrefix(NSString filePrefix)
→ FutureOr<void>
-
{zh}
@brief 设置文件前缀。
@param filePrefix 需要设置的文件前缀。
@notes 前缀不能以 '/' 开头。
-
setImageHostName(NSString hostName)
→ FutureOr<void>
-
{zh}
@brief 设置 apply 阶段的 host。
@param hostName 需要设置的 host。
-
setImageRegionName(NSString regionName)
→ FutureOr<void>
-
{zh}
@brief 设置 imagex 图片上传实例的 region。
@param regionName 需要设置的 region。
-
setImageSceneTag(NSString sceneTag)
→ FutureOr<void>
-
{zh}
@brief 设置场景 tag。
@param sceneTag 需要设置的场景 tag。
-
setRequestParameter(NSDictionary parameter)
→ FutureOr<void>
-
{zh}
@brief 设置自定义请求参数。
@param parameter 需要设置的请求参数。
@notes 参数说明：
key type Describe
BDFileUploadFileType NSString 上传文件类型，比如 "image"
BDFileUploadTraceId NSString 上传跟踪标识，可将该次上传于业务行为进行关联
BDFileUploadCustomedParameter NSString apply 阶段需要携带的自定义参数
-
setUploadConfig(NSDictionary config)
→ FutureOr<void>
-
{zh}
@brief 设置上传的配置策略。
@param config 需要配置的上传策略。
@notes
键值 类型 描述 是否必须
BDFileUploadSliceRetryCount NSNumber(NSInteger) 分片失败重试次数 NO
BDFileUploadFileRetryCount NSNumber(NSInteger) 文件失败重试次数 NO
BDFileUploadTranTimeOutUnit NSNumber(NSInteger) socket 单次读写超时时间 NO
BDFileUploadSliceSize NSNumber(NSInteger) 分片的大小 NO
BDFileUploadSocketNum NSNumber(NSInteger) 并行分片上传线程数 NO
BDFileUploadMaxFailTimes NSNumber(NSInteger) 最大建联失败时间 NO
BDFileUploadAliveMaxFailTime NSNumber(NSInteger) 复用连接情况下最大超时时间 NO
BDFileUploadTcpOpenTimeOutMilliSec NSNumber(NSInteger) tcp 建联超时时间 NO
BDFileUploadRWTimeout NSNumber(NSInteger) socket 读写超时时间 NO
BDFileUploadHttpsEnable NSNumber(BOOL) 是否开启 https NO
BDFileUploadEnableCommitUpload NSNumber(NSInteger) 是否跳过上报阶段（0:跳过,1:不跳过,2:不依赖） NO
BDFileUploadSkipMeta NSNumber(NSInteger) 是否返回 meta 信息（0:不跳过,1:跳过） NO
BDFileUploadSliceThreshold NSNumber(NSInteger) 开启分片上传的阈值 NO
BDFileUploadMaxConcurrentFileNum NSNumber(NSInteger) 并行上传的文件数量 NO
-
start()
→ FutureOr<void>
-
{zh}
@brief 开始上传。
-
stop()
→ FutureOr<void>
-
{zh}
@brief 暂停上传。
-
toString()
→ String
-
A string representation of this object.
inherited
-
updateResource(NativeResource resource)
→ void
-
inherited
