MobSDK.h 2.3 KB

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