MMEConstants.h 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218
  1. #import <Foundation/Foundation.h>
  2. #import "MMETypes.h"
  3. extern NSString * const MMEAPIClientBaseEventsURL;
  4. extern NSString * const MMEAPIClientBaseAPIURL;
  5. extern NSString * const MMEAPIClientBaseChinaEventsURL;
  6. extern NSString * const MMEAPIClientBaseChinaAPIURL;
  7. extern NSString * const MMEAPIClientEventsPath;
  8. extern NSString * const MMEAPIClientEventsConfigPath;
  9. extern NSString * const MMEAPIClientAttachmentsPath;
  10. extern NSString * const MMEAPIClientHeaderFieldUserAgentKey;
  11. extern NSString * const MMEAPIClientHeaderFieldContentTypeKey;
  12. extern NSString * const MMEAPIClientHeaderFieldContentTypeValue;
  13. extern NSString * const MMEAPIClientAttachmentsHeaderFieldContentTypeValue;
  14. extern NSString * const MMEAPIClientHeaderFieldContentEncodingKey;
  15. extern NSString * const MMEAPIClientHTTPMethodPost;
  16. extern NSString * const MMEAPIClientHTTPMethodGet;
  17. // Debug types
  18. extern NSString * const MMEDebugEventType;
  19. extern NSString * const MMEDebugEventTypeError;
  20. extern NSString * const MMEDebugEventTypeFlush;
  21. extern NSString * const MMEDebugEventTypePush;
  22. extern NSString * const MMEDebugEventTypePost;
  23. extern NSString * const MMEDebugEventTypePostFailed;
  24. extern NSString * const MMEDebugEventTypeTurnstile;
  25. extern NSString * const MMEDebugEventTypeTurnstileFailed;
  26. extern NSString * const MMEDebugEventTypeBackgroundTask;
  27. extern NSString * const MMEDebugEventTypeMetricCollection;
  28. extern NSString * const MMEDebugEventTypeLocationManager;
  29. extern NSString * const MMEDebugEventTypeTelemetryMetrics;
  30. extern NSString * const MMEDebugEventTypeCertPinning;
  31. // Event types
  32. extern NSString * const MMEEventTypeAppUserTurnstile;
  33. extern NSString * const MMEEventTypeTelemetryMetrics;
  34. extern NSString * const MMEEventTypeMapLoad;
  35. extern NSString * const MMEEventTypeLocation;
  36. extern NSString * const MMEEventTypeVisit;
  37. extern NSString * const MMEEventTypeLocalDebug;
  38. extern NSString * const MMEventTypeOfflineDownloadStart;
  39. extern NSString * const MMEventTypeOfflineDownloadEnd;
  40. // Event keys
  41. extern NSString * const MMEEventKeyArrivalDate;
  42. extern NSString * const MMEEventKeyDepartureDate;
  43. extern NSString * const MMEEventKeyLatitude;
  44. extern NSString * const MMEEventKeyLongitude;
  45. extern NSString * const MMEEventKeyZoomLevel;
  46. extern NSString * const MMEEventKeyMaxZoomLevel;
  47. extern NSString * const MMEEventKeyMinZoomLevel;
  48. extern NSString * const MMEEventKeyEvent;
  49. extern NSString * const MMEEventKeyCreated;
  50. extern NSString * const MMEEventKeyStyleURL;
  51. extern NSString * const MMEEventKeySpeed;
  52. extern NSString * const MMEEventKeyCourse;
  53. extern NSString * const MMEEventKeySpeedAccuracy;
  54. extern NSString * const MMEEventKeyCourseAccuracy;
  55. extern NSString * const MMEEventKeyVerticalAccuracy;
  56. extern NSString * const MMEEventKeyPermissionStatus;
  57. extern NSString * const MMEEventKeyFloor;
  58. extern NSString * const MMEEventKeyVendorId;
  59. extern NSString * const MMEEventKeyModel;
  60. extern NSString * const MMEEventKeyDevice;
  61. extern NSString * const MMEEventKeyConfig;
  62. extern NSString * const MMEEventKeySkuId;
  63. extern NSString * const MMEEventKeyEnabledTelemetry;
  64. extern NSString * const MMEEventKeyOperatingSystem;
  65. extern NSString * const MMEEventKeyResolution;
  66. extern NSString * const MMEEventKeyAccessibilityFontScale;
  67. extern NSString * const MMEEventKeyOrientation;
  68. extern NSString * const MMEEventKeyPluggedIn;
  69. extern NSString * const MMEEventKeyWifi;
  70. extern NSString * const MMEEventKeyShapeForOfflineRegion;
  71. extern NSString * const MMEEventKeySource;
  72. extern NSString * const MMEEventKeySessionId;
  73. extern NSString * const MMEEventKeyApplicationState;
  74. extern NSString * const MMEEventKeyAltitude;
  75. extern NSString * const MMEEventKeyLocationAuthorization;
  76. extern NSString * const MMEEventKeyLocationEnabled;
  77. extern NSString * const MMEEventKeyAccuracyAuthorization;
  78. extern NSString * const MMEEventHorizontalAccuracy;
  79. extern NSString * const MMEEventSDKIdentifier;
  80. extern NSString * const MMEEventSDKVersion;
  81. extern NSString * const MMEEventKeyLocalDebugDescription;
  82. extern NSString * const MMEEventKeyErrorCode;
  83. extern NSString * const MMEEventKeyErrorDomain;
  84. extern NSString * const MMEEventKeyErrorDescription;
  85. extern NSString * const MMEEventKeyErrorFailureReason;
  86. extern NSString * const MMEEventKeyErrorNoReason;
  87. extern NSString * const MMEEventKeyErrorNoDomain;
  88. extern NSString * const MMEEventKeyFailedRequests;
  89. extern NSString * const MMEEventKeyHeader;
  90. extern NSString * const MMEEventKeyPlatform;
  91. extern NSString * const MMEEventKeyUserAgent;
  92. extern NSString * const MMEEventKeyiOS;
  93. extern NSString * const MMEEventKeyMac;
  94. extern NSString * const MMEEventKeyApproximate;
  95. extern NSString * const MMEEventKeyLocationsForeground;
  96. extern NSString * const MMEEventKeyLocationsBackground;
  97. extern NSString * const MMEEventKeyLocationsWithApproximateValues;
  98. extern NSString * const MMEEventKeyLocationsDroppedBecauseOfHAF;
  99. extern NSString * const MMEEventKeyLocationsDroppedDueTimeout;
  100. extern NSString * const MMEEventKeyLocationsConvertedIntoEvents;
  101. extern NSString * const MMENavigationEventPrefix;
  102. extern NSString * const MMEVisionEventPrefix;
  103. extern NSString * const MMEEventTypeNavigationDepart;
  104. extern NSString * const MMEEventTypeNavigationArrive;
  105. extern NSString * const MMEEventTypeNavigationCancel;
  106. extern NSString * const MMEEventTypeNavigationFeedback;
  107. extern NSString * const MMEEventTypeNavigationReroute;
  108. extern NSString * const MMEventTypeNavigationCarplayConnect;
  109. extern NSString * const MMEventTypeNavigationCarplayDisconnect;
  110. extern NSString * const MMEEventTypeSearchSelected;
  111. extern NSString * const MMEEventTypeSearchFeedback;
  112. extern NSString * const MMESearchEventPrefix;
  113. extern NSString * const MMEEventDateUTC;
  114. extern NSString * const MMEEventRequests;
  115. extern NSString * const MMEEventTotalDataSent;
  116. extern NSString * const MMEEventCellDataSent;
  117. extern NSString * const MMEEventWiFiDataSent;
  118. extern NSString * const MMEEventTotalDataReceived;
  119. extern NSString * const MMEEventCellDataReceived;
  120. extern NSString * const MMEEventWiFiDataReceived;
  121. extern NSString * const MMEEventAppWakeups;
  122. extern NSString * const MMEEventEventCountPerType;
  123. extern NSString * const MMEEventEventCountFailed;
  124. extern NSString * const MMEEventEventCountTotal;
  125. extern NSString * const MMEEventEventCountMax;
  126. extern NSString * const MMEEventDeviceLat;
  127. extern NSString * const MMEEventDeviceLon;
  128. extern NSString * const MMEEventDeviceTimeDrift;
  129. extern NSString * const MMEEventConfigResponse;
  130. extern NSString * const MMEEventStatusDenied;
  131. extern NSString * const MMEEventStatusRestricted;
  132. extern NSString * const MMEEventStatusNotDetermined;
  133. extern NSString * const MMEEventStatusAuthorizedAlways;
  134. extern NSString * const MMEEventStatusAuthorizedWhenInUse;
  135. extern NSString * const MMEEventAuthStatusAllow;
  136. extern NSString * const MMEEventAuthStatusAllowWhenInUse;
  137. extern NSString * const MMEEventAuthStatusAllowAlways;
  138. extern NSString * const MMEEventUnknown;
  139. extern NSString * const MMEAccuracyAuthorizationFull;
  140. extern NSString * const MMEAccuracyAuthorizationReduced;
  141. extern NSString * const MMEResponseKey;
  142. /*! @brief SDK event source */
  143. extern NSString * const MMEEventSource;
  144. #pragma mark - mobile.crash Keys
  145. extern NSString * const MMEEventMobileCrash;
  146. extern NSString * const MMEEventKeyOSVersion;
  147. extern NSString * const MMEEventKeyBuildType;
  148. extern NSString * const MMEEventKeyIsSilentCrash;
  149. extern NSString * const MMEEventKeyStackTrace;
  150. extern NSString * const MMEEventKeyStackTraceHash;
  151. extern NSString * const MMEEventKeyInstallationId;
  152. extern NSString * const MMEEventKeyThreadDetails;
  153. extern NSString * const MMEEventKeyAppId;
  154. extern NSString * const MMEEventKeyAppVersion;
  155. extern NSString * const MMEEventKeyAppStartDate;
  156. extern NSString * const MMEEventKeyCustomData;
  157. #pragma mark - MMEErrorDomain
  158. /*! @brief NSErrorDomain for MapboxMobileEvents */
  159. extern NSErrorDomain const MMEErrorDomain;
  160. /*! @brief MMEErrorDomain Error Numbers
  161. - MMENoError: No Error
  162. - MMEErrorException for exceptions
  163. - MMEErrorEventInit for errors when initlizing events
  164. - MMEErrorEventInitMissingKey if the event attributes dictionary does not include the event key,
  165. - MMEErrorEventInitException if an exception occured durring initWithAttributes:error:,
  166. - MMEErrorEventInitInvalid if the provided eventAttributes cannot be converted to JSON objects
  167. */
  168. typedef NS_ENUM(NSInteger, MMEErrorNumber) {
  169. MMENoError = 0,
  170. MMEErrorException = 10001,
  171. MMEErrorEventInit = 10002,
  172. MMEErrorEventInitMissingKey = 10003,
  173. MMEErrorEventInitException = 10004,
  174. MMEErrorEventInitInvalid = 10005,
  175. MMEErrorEventEncoding = 10006,
  176. MMEErrorEventCounting = 10007,
  177. MMEErrorConfigUpdateError = 10008
  178. };
  179. /*! @brief key for MMEErrorEventInit userInfo dictionary containing the attributes which failed to create the event */
  180. extern NSString * const MMEErrorEventAttributesKey;
  181. /*! @brief key for MMEErrorDomain userInfo dictionary containing the underlying exception which triggered the error */
  182. extern NSString * const MMEErrorUnderlyingExceptionKey;
  183. #pragma mark - Deprecated
  184. extern NSString * const MMEAPIClientBaseURL MME_DEPRECATED_MSG("Use MMEAPIClientBaseEventsURL");
  185. extern NSString * const MMEErrorDescriptionKey MME_DEPRECATED_MSG("Use NSLocalizedDescriptionKey");
  186. extern NSString * const MMEEventKeyVendorID MME_DEPRECATED_MSG("Use MMEEventKeyVendorId");
  187. extern NSString * const MMEEventKeyInstallationID MME_DEPRECATED_MSG("Use MMEEventKeyInstallationId");
  188. extern NSString * const MMEEventKeyAppID MME_DEPRECATED_MSG("Use MMEEventKeyInstallationId");
  189. extern NSString * const MMEEventKeyGestureId MME_DEPRECATED;
  190. extern NSString * const MMEEventKeyGestureID MME_DEPRECATED;
  191. extern NSString * const MMEEventGestureSingleTap MME_DEPRECATED;
  192. extern NSString * const MMEEventGestureDoubleTap MME_DEPRECATED;
  193. extern NSString * const MMEEventGestureTwoFingerSingleTap MME_DEPRECATED;
  194. extern NSString * const MMEEventGestureQuickZoom MME_DEPRECATED;
  195. extern NSString * const MMEEventGesturePanStart MME_DEPRECATED;
  196. extern NSString * const MMEEventGesturePinchStart MME_DEPRECATED;
  197. extern NSString * const MMEEventGestureRotateStart MME_DEPRECATED;
  198. extern NSString * const MMEEventGesturePitchStart MME_DEPRECATED;
  199. extern NSString * const MMEEventTypeMapTap MME_DEPRECATED;
  200. extern NSString * const MMEEventTypeMapDragEnd MME_DEPRECATED;