MobSDK.h 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889
  1. //
  2. // MobSDK.h
  3. // MOBFoundation
  4. //
  5. // Created by 冯鸿杰 on 17/2/23.
  6. // Copyright © 2017年 MOB. All rights reserved.
  7. //
  8. #import <Foundation/Foundation.h>
  9. /**
  10. MobSDK
  11. */
  12. @interface MobSDK : NSObject
  13. /**
  14. 获取版本号
  15. @return 版本号
  16. */
  17. + (NSString * _Nonnull)version;
  18. /**
  19. 获取应用标识
  20. @return 应用标识
  21. */
  22. + (NSString * _Nullable)appKey;
  23. /**
  24. 获取应用密钥
  25. @return 应用密钥
  26. */
  27. + (NSString * _Nullable)appSecret;
  28. /**
  29. 变更应用密钥,针对服务器刷新应用密钥后,可以通过该方法进行修改
  30. @param appSecret 应用密钥
  31. */
  32. + (void)changeAppSecret:(NSString * _Nonnull)appSecret;
  33. /**
  34. 注册appKey、appSecret
  35. @param appKey appKey
  36. @param appSecret appSecret
  37. */
  38. + (void)registerAppKey:(NSString * _Nonnull)appKey
  39. appSecret:(NSString * _Nonnull)appSecret;
  40. #pragma mark - User
  41. /**
  42. 设置用户
  43. @param uid 用户标识,对应应用自身用户系统的用户唯一标志,不一定是实际的用户ID,可以通过数据变换的方式(如:MD5(userID))来生成该ID,但一定要能够唯一标识用户。设置nil表示注销用户,解除绑定
  44. @param nickname 昵称
  45. @param avatar 头像
  46. @param userData 用户自定义数据
  47. */
  48. + (void)setUserWithUid:(NSString * _Nullable)uid
  49. nickName:(NSString * _Nullable)nickname
  50. avatar:(NSString * _Nullable)avatar
  51. userData:(NSDictionary * _Nullable)userData;
  52. /**
  53. 设置用户
  54. @param uid 用户标识,对应应用自身用户系统的用户唯一标志,不一定是实际的用户ID,可以通过数据变换的方式(如:MD5(userID))来生成该ID,但一定要能够唯一标识用户。设置nil表示注销用户,解除绑定
  55. @param nickname 昵称
  56. @param avatar 头像
  57. @param userData 用户自定义数据
  58. */
  59. + (void)setUserWithUid:(NSString * _Nullable)uid
  60. nickName:(NSString * _Nullable)nickname
  61. avatar:(NSString * _Nullable)avatar
  62. sign:(NSString * _Nullable)sign
  63. userData:(NSDictionary * _Nullable)userData;
  64. /**
  65. 清空用户
  66. */
  67. + (void)clearUser;
  68. @end