NIMDocTranscodingManagerProtocol.h 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  1. //
  2. // NIMDocTranscodingManagerProtocol.h
  3. // NIMLib
  4. //
  5. // Created by Netease.
  6. // Copyright (c) 2016 Netease. All rights reserved.
  7. //
  8. #import <Foundation/Foundation.h>
  9. @class NIMDocTranscodingInfo;
  10. NS_ASSUME_NONNULL_BEGIN
  11. /**
  12. 查询文档转码信息结果 block
  13. @param error 执行结果,如果成功则为 nil
  14. @param info 查询到的文档转码信息
  15. */
  16. typedef void(^NIMDocTranscodingInquireCompleteBlock)(NSError * __nullable error, NIMDocTranscodingInfo * __nullable info);
  17. /**
  18. 拉取文档转码信息列表结果 block
  19. @param error 执行结果,如果成功则为 nil
  20. @param infos 拉取到的所有文档转码信息
  21. */
  22. typedef void(^NIMDocTranscodingFetchCompleteBlock)(NSError * __nullable error, NSArray<NIMDocTranscodingInfo *> * __nullable infos);
  23. /**
  24. * 删除转码文档结果 block
  25. *
  26. @param error 执行结果,如果成功则为 nil
  27. */
  28. typedef void(^NIMDocTranscodingDeleteCompleteBlock)(NSError * __nullable error);
  29. /**
  30. * 文档转码管理器
  31. */
  32. @protocol NIMDocTranscodingManager <NSObject>
  33. /**
  34. 查询文档转码信息
  35. @param docId 转码文档标识 id
  36. @param completion 查询结果 block
  37. */
  38. - (void)inquireDocInfo:(NSString *)docId
  39. completion:(nullable NIMDocTranscodingInquireCompleteBlock)completion;
  40. /**
  41. 拉取文档转码信息列表
  42. @param lastDocId 最后一个文档的锚点,不包括此文档。填 nil 会从最新提交的转码文档开始往前查询。
  43. @param limit 拉取文档的最大个数,每次拉取的个数不能超过 30
  44. @param completion 拉取结果 block
  45. */
  46. - (void)fetchMyDocsInfo:(nullable NSString *)lastDocId
  47. limit:(NSUInteger)limit
  48. completion:(nullable NIMDocTranscodingFetchCompleteBlock)completion;
  49. /**
  50. 删除转码文档
  51. @param docId 转码文档标识 id
  52. @param completion 删除转码文档结果 block
  53. */
  54. - (void)deleteDoc:(NSString *)docId
  55. completion:(nullable NIMDocTranscodingDeleteCompleteBlock)completion;
  56. @end
  57. NS_ASSUME_NONNULL_END