WhiteConverter Class Reference
- iOS
更新时间
Whiteboard iOS SDK 2.16.147 公开接口。
@interface WhiteConverter: NSObject
成员
- init
- initWithRoomToken:
- initWithRoomToken:pollingInterval:timeout:
- roomToken
- interval
- timeout
- taskId
- error
- type
- status
- startConvertTask:type:progress:completionHandler:
- startPolling:completionHandler:
– init
- (instancetype)init NS_UNAVAILABLE;Declared in Converter/V4/WhiteConverter.h
– initWithRoomToken:
- (instancetype)initWithRoomToken:(NSString *)roomToken;Declared in Converter/V4/WhiteConverter.h
– initWithRoomToken:pollingInterval:timeout:
- (instancetype)initWithRoomToken:(NSString *)roomToken pollingInterval:(NSTimeInterval)interval timeout:(NSTimeInterval)timeout;Declared in Converter/V4/WhiteConverter.h
roomToken
@property (nonatomic, copy, readonly) NSString *roomToken;Declared in Converter/V4/WhiteConverter.h
interval
@property (nonatomic, assign) NSTimeInterval interval;轮询间隔时间,默认 15s,从前一个请求完整结束,开始计时Declared in Converter/V4/WhiteConverter.h
timeout
@property (nonatomic, assign) NSTimeInterval timeout;轮询超时停止时间,默认 3 分钟Declared in Converter/V4/WhiteConverter.h
taskId
@property (nonatomic, copy, readonly, nullable) NSString *taskId;服务器转换任务的 uuid。如遇错,可以提供 taskId 和 type 类型进行排查。
只有成功创建转换任务,才会有 taskId,如果未开启服务Declared in Converter/V4/WhiteConverter.h
error
@property (nonatomic, strong, readonly, nullable) NSError *error;错误信息Declared in Converter/V4/WhiteConverter.h
type
@property (nonatomic, assign, readonly) ConvertType type;转换类型,在创建转换任务时,传入。Declared in Converter/V4/WhiteConverter.h
status
@property (nonatomic, assign, readonly) ConverterStatus status;Declared in Converter/V4/WhiteConverter.h
– startConvertTask:type:progress:completionHandler:
- (void)startConvertTask:(NSString *)url type:(ConvertType)type progress:(_Nullable ConvertProgress)progress completionHandler:(_Nullable ConvertCompletionHandler)completionHandler;创建文档转换服务,并开始轮询请求服务器。
部分状态下无法新建服务,具体看 @link{{ConverterStatus}} 枚举
@param url 文档所在网络地址,需要对外可下载(即使无法下载,也会成功创建转换服务,但是会立即变成转换失败状态),SDK 服务器会去下载,然后进行转换。
@param type 文档类型
@param progress 进度回调提示
@param completionHandler 转换完成回调(主线程回调)Declared in Converter/V4/WhiteConverter.h
– startPolling:completionHandler:
- (void)startPolling:(_Nullable ConvertProgress)progress completionHandler:(_Nullable ConvertCompletionHandler)completionHandler;重新轮询执行检查(外部调用时,只有ConverterStatusTimeout,才允许重新开启轮询检查)
间隔与超时时间,继承 启动文档转换服务 API 的设置
@param progress 进度回调
@param completionHandler 转换完成回调(主线程回调)Declared in Converter/V4/WhiteConverter.h