IQConstants.h 2.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. //
  2. // IQConstants.h
  3. // ConnectIQ
  4. //
  5. // Copyright (c) 2014 Garmin. All rights reserved.
  6. //
  7. #import <Foundation/Foundation.h>
  8. /// @brief The current version of the ConnectIQ SDK.
  9. extern int const IQSDKVersion;
  10. /// @brief The bundle identifier for the Garmin Connect Mobile app.
  11. extern NSString * const IQGCMBundle;
  12. /// @brief The result of a SendMessage operation
  13. typedef NS_ENUM(NSInteger, IQSendMessageResult){
  14. ///! @brief The message was sent successfully.
  15. IQSendMessageResult_Success,
  16. /// @brief The message failed to send due to an unknown error.
  17. IQSendMessageResult_Failure_Unknown,
  18. /// @brief The message failed to send. There was an error within the SDK or
  19. /// on the device.
  20. IQSendMessageResult_Failure_InternalError,
  21. /// @brief The message failed to send. The device is not available right now.
  22. IQSendMessageResult_Failure_DeviceNotAvailable,
  23. /// @brief The message failed to send. The app is not installed on the
  24. /// device.
  25. IQSendMessageResult_Failure_AppNotFound,
  26. /// @brief The message failed to send. The device is busy and cannot receive
  27. /// the message right now.
  28. IQSendMessageResult_Failure_DeviceIsBusy,
  29. /// @brief The message failed to send. The message contained an unsupported
  30. /// type.
  31. IQSendMessageResult_Failure_UnsupportedType,
  32. /// @brief The message failed to send. The device does not have enough memory
  33. /// to receive the message.
  34. IQSendMessageResult_Failure_InsufficientMemory,
  35. /// @brief The message failed to send. The connection timed out while sending
  36. /// the message.
  37. IQSendMessageResult_Failure_Timeout,
  38. /// @brief The message failed to send and was retried, but could not complete
  39. /// after a number of tries.
  40. IQSendMessageResult_Failure_MaxRetries,
  41. /// @brief The message was received by the device but it chose not to display
  42. /// a message prompt, ignoring the message.
  43. IQSendMessageResult_Failure_PromptNotDisplayed,
  44. /// @brief The message was received by the device but the app to open
  45. /// was already running on the device.
  46. IQSendMessageResult_Failure_AppAlreadyRunning,
  47. };
  48. NSString *NSStringFromSendMessageResult(IQSendMessageResult value);