JMSGFriendManager.h 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111
  1. //
  2. // JMSGFriendManager.h
  3. // JMessage
  4. //
  5. // Created by xudong.rao on 16/7/25.
  6. // Copyright © 2016年 HXHG. All rights reserved.
  7. //
  8. #import <Foundation/Foundation.h>
  9. #import <JMessage/JMSGConstants.h>
  10. @interface JMSGFriendManager : NSObject
  11. /*!
  12. * @abstract 获取好友列表
  13. *
  14. * @param handler 结果回调。回调参数:
  15. *
  16. * - resultObject 类型为 NSArray,数组里成员的类型为 JMSGUser
  17. * - error 错误信息
  18. *
  19. * 如果 error 为 nil, 表示设置成功
  20. * 如果 error 不为 nil,表示设置失败
  21. *
  22. * @discussion 从服务器获取,异步返回结果,返回用户的好友列表。
  23. * 建议开发者在 SDK 完全启动之后,再调用此接口获取数据
  24. */
  25. + (void)getFriendList:(JMSGCompletionHandler)handler;
  26. /*!
  27. * @abstract 发送添加好友请求
  28. *
  29. * @param username 对方用户名
  30. * @param userAppKey 对方所在应用appkey,不传则默认是本应用
  31. * @param reason 添加好友时的备注,可不填
  32. *
  33. * @param handler 结果回调。回调参数
  34. *
  35. * - resultObject 相应的返回对象
  36. * - error 错误信息
  37. *
  38. * 如果 error 为 nil, 表示设置成功
  39. * 如果 error 不为 nil,表示设置失败
  40. *
  41. * @discussion 在对方未做回应的前提下,允许重复发送添加好友的请求。
  42. */
  43. + (void)sendInvitationRequestWithUsername:(NSString *)username
  44. appKey:(NSString *)userAppKey
  45. reason:(NSString *)reason
  46. completionHandler:(JMSGCompletionHandler)handler;
  47. /*!
  48. * @abstract 接受好友邀请
  49. *
  50. * @param username 对方用户名
  51. * @param userAppKey 对方所在应用appkey,不传则默认是本应用
  52. *
  53. * @param handler 结果回调。回调参数:
  54. *
  55. * - resultObject 相应的返回对象
  56. * - error 错误信息
  57. *
  58. * 如果 error 为 nil, 表示设置成功
  59. * 如果 error 不为 nil,表示设置失败
  60. *
  61. */
  62. + (void)acceptInvitationWithUsername:(NSString *)username
  63. appKey:(NSString *)userAppKey
  64. completionHandler:(JMSGCompletionHandler)handler;
  65. /*!
  66. * @abstract 拒绝好友邀请
  67. *
  68. * @param username 对方用户名
  69. * @param userAppKey 对方所在应用appkey,不传则默认是本应用
  70. * @param reason 拒绝理由,可不传
  71. *
  72. * @param handler 结果回调。回调参数:
  73. *
  74. * - resultObject 相应的返回对象
  75. * - error 错误信息
  76. *
  77. * 如果 error 为 nil, 表示设置成功
  78. * 如果 error 不为 nil,表示设置失败
  79. *
  80. */
  81. + (void)rejectInvitationWithUsername:(NSString *)username
  82. appKey:(NSString *)userAppKey
  83. reason:(NSString *)reason
  84. completionHandler:(JMSGCompletionHandler)handler;
  85. /*!
  86. * @abstract 删除好友
  87. *
  88. * @param username 好友username
  89. * @param userAppKey 好友所在应用appkey,不传则默认是本应用
  90. *
  91. * @param handler 结果回调。回调参数:
  92. *
  93. * - resultObject 相应对象
  94. * - error 错误信息
  95. *
  96. * 如果 error 为 nil, 表示设置成功
  97. * 如果 error 不为 nil,表示设置失败
  98. *
  99. * @discussion
  100. */
  101. + (void)removeFriendWithUsername:(NSString *)username
  102. appKey:(NSString *)userAppKey
  103. completionHandler:(JMSGCompletionHandler)handler;
  104. @end