BDImageXUploader class

Inheritance
  • Object
  • NativeClass
  • BDImageXUploader

Constructors

BDImageXUploader.new([NativeClassOptions? options])

Properties

$resource → NativeResource
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
ready Future<void>
Whether the instance is initialized
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

close() FutureOr<void>
{zh} @brief 终止上传,并释放底层上传对象,释放后不能够继续进行上传。
destroy() → void
inherited
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
setEnableCommitUpload(int commitType) FutureOr<void>
{zh} @brief 设置是否跳过上传成功后的上报阶段,默认跳过
setEnableEnd2EndEncryption(int option) FutureOr<void>
{zh} @brief 设置是否使用 全链路加密功能 option > 0 使用,默认关闭
setEnableExternDNS(int isEnableExternDNS) FutureOr<void>
{zh} @brief 对 uploader 实例开启 httpdns 重试功能,取值请指定为 1
setEnableHttpDnsRetry(int enableHttpDnsRetry) FutureOr<void>
{zh} @brief 对 uploader 实例开启 httpdns 重试功能,取值请指定为 1
setEnableHttps(int isEnableHttps) FutureOr<void>
{zh} @brief 开启 https,设置 1 为全开启
setEnableLogCallBack(boolean isEnableLogCallBack) FutureOr<void>
{zh} @brief 设置开启日志回调 @note 需要结合,BDImageXUploaderListener 的 onLog 回调一起使用
setEnableMd5StoryKey(boolean enable) FutureOr<void>
{zh} @brief 使用文件的 md5 作为文件名
setEnableOverwrite(boolean enable) FutureOr<void>
{zh} @brief 开启文件重名覆盖上传
setEnableSkipMeta(boolean skip) FutureOr<void>
{zh} @brief 设置是否返回图片 Meta 信息,默认值为 false
setEnd2EndEncryptionAESKey(String key) FutureOr<void>
{zh} @brief 设置 AES key,即对称密钥,用于加密上传文件。支持 SDK 随机生成和自定义 @note 您可以选择不设置,上传 sdk 将自动生成,在上传成功后经回调返回具体内容 如果您需自定义密钥内容,需为 32 位字符串,并经 base64 编码之后传入
setEnd2EndEncryptionPublicKey(String key) FutureOr<void>
{zh} @brief 设置 RSA 公钥, 用于加密对称密钥。请从控制台配置和获取。 @note 可选(当上传后不需要 ImageX 服务端进行处理时,可以不填。上传需要 commit上报阶段或者需要返回 meta信息时必填) 上传默认获取 meta,可通过 mUploader.setEnableSkipMeta(true); 关闭获取 meta
setFileExtension(String fileExtension) FutureOr<void>
{zh} @brief 设置后缀,可选,需要以 . 开头
setFileName(int num, Array<String> mFileNames) FutureOr<void>
{zh} @brief 设置文件名称数组
setFileNum(int num) FutureOr<void>
{zh} @brief 设置上传文件数量
setFilePath(int num, Array<String> path) FutureOr<void>
{zh} @brief 设置上传文件绝对路径
setFilePrefix(String filePrefix) FutureOr<void>
{zh} @brief 设置文件前缀
setFileRetryCount(int retryCount) FutureOr<void>
{zh} @brief 文件级别的重试次数,默认值 3
setFileStoreKeys(int num, Array<String> storeKeys) FutureOr<void>
{zh} @brief 自定义上传文件的存储 key
setListener(BDImageXUploaderListener listener) FutureOr<void>
{zh} @brief 设置上传回调,在 A 线程创建 Uploader 实例,如果 A 线程存在 Looper,则在 A 线程回调;否则在主线程回调。
setMaxConcurrentFileNum(int num) FutureOr<void>
{zh} @brief 设置并行上传的文件数(上传多张图片的情况),建议设置的最大并行数,应该是小于等于传入的图片数目。默认值 1
setMaxFailTime(int maxTime) FutureOr<void>
{zh} @brief 总的建联超时,单位 s,默认 70
setRWTimeout(int timeOut) FutureOr<void>
{zh} @brief 单个分片传输超时,单位为 s,默认值为 40
setServerParameter(String value) FutureOr<void>
{zh} @brief 设置自定义参数,如 appid(应用 ID)、did(设备唯一标识)、uid(用户唯一标识) 和 region (地域)等,以便您排查上传日志。
setServiceID(String value) FutureOr<void>
{zh} @brief 设置服务ID
setSliceRetryCount(int retryCount) FutureOr<void>
{zh} @brief 分片重试次数,默认值 2
setSliceSize(int size) FutureOr<void>
{zh} @brief 分片上传设置分片大小,单位 byte,默认值 512 * 1024;
setSliceThreshold(int value) FutureOr<void>
{zh} @brief 设置分片大小阈值
setSocketNum(int num) FutureOr<void>
{zh} @brief 设置单张图片并行上传的线程数,只有走分片上传的情况才生效,默认值 1
setSpecifiedContentType(int num, Array<String> mSpecifiedContentType) FutureOr<void>
{zh} @brief 设置上传文件的 Content-Type,需要和上传文件数组一一对应
setStringValue(int key, String value) FutureOr<void>
{zh} @brief 设置String Value
setTopAccessKey(String value) FutureOr<void>
{zh} @brief 设置AK
setTopSecretKey(String value) FutureOr<void>
{zh} @brief 设置SK
setTopSessionToken(String value) FutureOr<void>
{zh} @brief 设置Token
setTraceId(String traceId) FutureOr<void>
{zh} @brief 设置 trace ID
setTranTimeOutUnit(int tranTimeOutUnit) FutureOr<void>
{zh} @brief 系统 socket 单次读写超时,单位 s,默认 10
setUploadDomain(String value) FutureOr<void>
{zh} @brief 设置域名
start() FutureOr<void>
{zh} @brief 开始上传 @note SDK 内部在执行此函数的时候,会新建线程,不会阻塞。
stop() FutureOr<void>
{zh} @brief 暂停上传
toString() String
A string representation of this object.
inherited
updateResource(NativeResource resource) → void
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited