TapFriends.h 1.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  1. //
  2. // TapFriends.h
  3. // TapLoginSDK
  4. //
  5. // Created by pzheng on 2022/02/23.
  6. //
  7. #import <Foundation/Foundation.h>
  8. NS_ASSUME_NONNULL_BEGIN
  9. /// Tap Friend Info
  10. @interface TapFriendInfo : NSObject
  11. /// Nickname.
  12. @property (nonatomic, readonly) NSString *name;
  13. /// Avatar.
  14. @property (nonatomic, readonly) NSString *avatar;
  15. /// Open ID.
  16. @property (nonatomic, readonly) NSString *openid;
  17. @end
  18. /// Query Result
  19. @interface TapFriendResult : NSObject
  20. /// List of `TapFriendInfo`.
  21. @property (nonatomic, nullable, readonly) NSArray<TapFriendInfo *> *data;
  22. /// The start index of the next query.
  23. @property (nonatomic, nullable, readonly) NSString *cursor;
  24. @end
  25. /// Query Option
  26. @interface TapFriendQueryOption : NSObject
  27. /// The limit of the result.
  28. @property (nonatomic) NSUInteger size;
  29. /// The start index of this query.
  30. @property (nonatomic, nullable) NSString *cursor;
  31. @end
  32. /// Tap Friends
  33. @interface TapFriends : NSObject
  34. /// Query mutual list.
  35. /// @param option See `TapFriendQueryOption`.
  36. /// @param callback Result callback.
  37. + (void)queryMutualListWithOption:(TapFriendQueryOption * _Nullable)option
  38. callback:(void (^)(TapFriendResult * _Nullable result, NSError * _Nullable error))callback;
  39. @end
  40. NS_ASSUME_NONNULL_END