MTA.h 1.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  1. //
  2. // XGPushStatMTA.h
  3. // XGPushStatMTA-SDK
  4. //
  5. // Originally Created by uweiyuan on 2019/7/4.
  6. // Copyright (c) 2020 TEG of Tencent. All rights reserved.
  7. //
  8. #import <Foundation/Foundation.h>
  9. /**
  10. XGPushStatMTA版本号
  11. */
  12. #define MTA_SDK_VERSION @"2.6.0"
  13. #pragma mark - 接口监控相关数据结构
  14. /**
  15. 接口统计的枚举值
  16. */
  17. typedef enum {
  18. /**
  19. 接口调用成功
  20. */
  21. XGPushStatMTA_SUCCESS = 0,
  22. /**
  23. 接口调用失败
  24. */
  25. XGPushStatMTA_FAILURE = 1,
  26. /**
  27. 接口调用出现逻辑错误
  28. */
  29. XGPushStatMTA_LOGIC_FAILURE = 2
  30. } XGPushStatMTAAppMonitorErrorType;
  31. /**
  32. XGPushStatMTA错误码
  33. - XGPushStatEC_OK: 无错误
  34. - XGPushStatEC_SERVICE_DISABLE: XGPushStatMTA服务未启动,请检查是否调用[XGPushStatMTA startWithAppkey:]
  35. - XGPushStatEC_ARGUMENT_INVALID: 参数错误,比如eventID为空,或者在没有结束计时事件的情况下又重新开始计时事件
  36. - XGPushStatEC_INPUT_LENGTH_LIMIT: 参数过长,详细情况请查看自定义事件API的注释
  37. */
  38. typedef NS_ENUM(NSInteger, XGPushStatMTAErrorCode) {
  39. XGPushStatEC_OK = 0,
  40. XGPushStatEC_SERVICE_DISABLE = -1,
  41. XGPushStatEC_ARGUMENT_INVALID = 1000,
  42. XGPushStatEC_INPUT_LENGTH_LIMIT = 1001,
  43. };
  44. #pragma mark - XGPushStatMTA统计功能相关接口
  45. /// XGPushStatMTA核心类
  46. @interface XGPushStatMTA : NSObject
  47. #pragma mark - 获取XGPushStatMTA版本号
  48. /**
  49. 获取XGPushStatMTA版本号
  50. @return 返回XGPushStatMTA版本号
  51. */
  52. + (NSString *)getSdkVersion;
  53. #pragma mark - 启动XGPushStatMTA
  54. /**
  55. 启动XGPushStatMTA
  56. @param appkey 从网页申请的appKey
  57. */
  58. + (void)startWithAppkey:(NSString *)appkey;
  59. #pragma mark - XG
  60. @end