QYCustomActionConfig.h 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204
  1. //
  2. // QYCustomActionConfig.h
  3. // QYSDK
  4. //
  5. // Created by Netease on 7/28/16.
  6. // Copyright (c) 2017 Netease. All rights reserved.
  7. //
  8. /**
  9. * 本类提供了所有自定义行为的接口;每个接口对应一个自定义行为的处理,如果设置了,则使用设置的处理,如果不设置,则采用默认处理
  10. */
  11. @class QYAction;
  12. @class QYSelectedCommodityInfo;
  13. /**
  14. * 退出排队结果类型
  15. */
  16. typedef NS_ENUM(NSInteger, QYQuitWaitingType) {
  17. QYQuitWaitingTypeNone, //当前不是在排队状态
  18. QYQuitWaitingTypeContinue, //继续排队
  19. QYQuitWaitingTypeQuit, //退出排队
  20. QYQuitWaitingTypeCancel, //取消操作
  21. };
  22. typedef NS_ENUM(NSInteger, QYAvatarType) {
  23. QYAvatarTypeHumanStaff, //人工客服
  24. QYAvatarTypeRobotStaff, //机器人客服
  25. QYAvatarTypeCorp, //企业
  26. QYAvatarTypeCustomer, //访客
  27. };
  28. typedef NS_ENUM(NSInteger, QYLinkClickActionPolicy) {
  29. QYLinkClickActionPolicyCancel, //不使用七鱼默认WebView打开链接
  30. QYLinkClickActionPolicyOpen, //使用七鱼默认WebView打开链接
  31. };
  32. /**
  33. * action事件回调
  34. */
  35. typedef void (^QYActionBlock)(QYAction *action);
  36. /**
  37. * 客服会话链接点击事件回调
  38. */
  39. typedef QYLinkClickActionPolicy (^QYSessionLinkClickBlock)(NSString *linkAddress);
  40. /**
  41. * push链接点击事件回调
  42. */
  43. typedef void (^QYLinkClickBlock)(NSString *linkAddress);
  44. /**
  45. * bot点击事件回调
  46. */
  47. typedef void (^QYBotClickBlock)(NSString *target, NSString *params);
  48. /**
  49. * 退出排队回调
  50. */
  51. typedef void (^QYQuitWaitingBlock)(QYQuitWaitingType quitType);
  52. /**
  53. * 显示bot自定义信息回调
  54. */
  55. typedef void (^QYShowBotCustomInfoBlock)(NSArray *array);
  56. /**
  57. * bot商品卡片按钮点击事件回调
  58. */
  59. typedef void (^QYSelectedCommodityActionBlock)(QYSelectedCommodityInfo *commodityInfo);
  60. /**
  61. * 扩展视图点击回调
  62. *
  63. * @param extInfo 附带信息
  64. */
  65. typedef void (^QYExtraViewClickBlock)(NSString *extInfo);
  66. /**
  67. * 系统消息点击回调
  68. *
  69. * @param message 消息对象
  70. */
  71. typedef void (^QYSystemNotificationClickBlock)(id message);
  72. /**
  73. * 所有消息内事件点击回调
  74. *
  75. * @param eventName 事件名称
  76. * @param eventData 数据
  77. * @param messageId 消息ID
  78. */
  79. typedef void (^QYEventBlock)(NSString *eventName, NSString *eventData, NSString *messageId);
  80. /**
  81. * 自定义事件按钮点击回调
  82. *
  83. * @param dict 按钮信息
  84. */
  85. typedef void (^QYCustomButtonBlock)(NSDictionary *dict);
  86. /**
  87. * 消息头像点击回调
  88. *
  89. * @param type 头像类型:人工客服头像/机器人客服头像/企业头像/访客头像
  90. * @param accountID 帐号ID
  91. */
  92. typedef void (^QYAvatarClickBlock)(QYAvatarType type, NSString *accountID);
  93. /**
  94. * 自定义行为配置类:QYCustomActionConfig,单例模式
  95. */
  96. @interface QYCustomActionConfig : NSObject
  97. + (instancetype)sharedInstance;
  98. /**
  99. * action事件
  100. */
  101. @property (nonatomic, copy) QYActionBlock actionBlock;
  102. /**
  103. * 所有消息中的链接(自定义商品消息、文本消息、机器人答案消息)的回调处理
  104. */
  105. @property (nonatomic, copy) QYSessionLinkClickBlock linkClickBlock;
  106. /**
  107. * bot相关点击
  108. */
  109. @property (nonatomic, copy) QYBotClickBlock botClick;
  110. /**
  111. * 推送消息相关点击
  112. */
  113. @property (nonatomic, copy) QYLinkClickBlock pushMessageClick;
  114. /**
  115. * 显示bot自定义信息
  116. */
  117. @property (nonatomic, copy) QYShowBotCustomInfoBlock showBotCustomInfoBlock;
  118. /**
  119. * bot商品卡片按钮点击事件
  120. */
  121. @property (nonatomic, copy) QYSelectedCommodityActionBlock commodityActionBlock;
  122. /**
  123. * 扩展视图点击
  124. */
  125. @property (nonatomic, copy) QYExtraViewClickBlock extraClickBlock;
  126. /**
  127. * 系统消息点击
  128. */
  129. @property (nonatomic, copy) QYSystemNotificationClickBlock notificationClickBlock;
  130. /**
  131. * 消息内点击
  132. */
  133. @property (nonatomic, copy) QYEventBlock eventClickBlock;
  134. /**
  135. * 自定义事件按钮点击事件,仅用于“后台样式设置”的快捷入口按钮及+扩展按钮
  136. */
  137. @property (nonatomic, copy) QYCustomButtonBlock customButtonClickBlock;
  138. /**
  139. * 消息头像点击事件
  140. * @discussion 若点击机器人客服头像,accountID=QIYU_ROBOT;若点击某些企业消息头像,accountID=-1
  141. */
  142. @property (nonatomic, copy) QYAvatarClickBlock avatarClickBlock;
  143. /**
  144. * 帐号登录后是否拉取漫游消息
  145. */
  146. @property (nonatomic, assign) BOOL pullRoamMessage;
  147. /**
  148. * 拉取漫游消息条数,默认20条,最大100条
  149. */
  150. @property (nonatomic, assign) NSUInteger roamMessageLimit;
  151. /**
  152. * 设置录制或者播放语音完成以后是否自动deactivate AVAudioSession
  153. *
  154. * @param deactivate 是否deactivate,默认为YES
  155. */
  156. - (void)setDeactivateAudioSessionAfterComplete:(BOOL)deactivate;
  157. /**
  158. * 显示退出排队提示
  159. *
  160. * @param quitWaitingBlock 选择结果回调
  161. */
  162. - (void)showQuitWaitingAlert:(QYQuitWaitingBlock)quitWaitingBlock;
  163. @end