iOS SDK
Classes
Structures
- APIRateLimit
- DeviceDataNamespace
- DeviceDataPoint
- DeviceDataPointPersistModel
- DeviceDataPointSource
- DeviceDataQuery
- DeviceDataResultPage
- EmbeddableSurveyCompletionReason
- ExternalAccount
- ExternalAccountAuthorization
- ExternalAccountProvider
- ExternalAccountProviderCategory
- ExternalAccountProvidersQuery
- ExternalAccountStatus
- HTTPResponseError
- NotificationHistoryModel
- NotificationHistoryPage
- NotificationHistoryQuery
- NotificationSendStatusCode
- Organization
- ParticipantAccessToken
- ParticipantDemographics
- ParticipantGender
- ParticipantInfo
- ProjectDataCollectionSettings
- ProjectInfo
- ProjectType
- QueryableDeviceDataType
- SurveyAnswer
- SurveyAnswersPage
- SurveyAnswersQuery
- SurveyTask
- SurveyTaskQuery
- SurveyTaskResultPage
- SurveyTaskStatus
Enumerations
Enumerations
MyDataHelpsError
enum MyDataHelpsError : Error
Detailed categorization of errors produced by MyDataHelpsKit.
Do not expect error descriptions to be user-readable or localized, unless otherwise specified.
case decodingError(Error)Failure to decode a model object.
case encodingError(Error)Failure to encode a model object.
case serverError(HTTPResponseError)Unexpected server error, e.g. an HTTP 500 error. Check the included HTTPResponseError for details, and contact support if you need help determining the problem.
case tooManyRequests(APIRateLimit, HTTPResponseError)Server request limit exceeded. The associated APIRateLimit indicates when throttling will reset, and the HTTPResponseError may include an error message (non-localized) suitable for debugging. Contact support with any questions.
case timedOut(Error)A server request timed out.
case unauthorizedRequest(HTTPResponseError)A server request had a missing or invalid access token. The access token should be refreshed and a new ParticipantSession created, if applicable.
case webContentError(Error?)Web content (e.g. an embeddable survey) unexpectedly failed to load, due to a network, server, or web content failure. Includes any underlying error, if available.
case unknown(Error?)A wrapper for unexpected errors. Includes the underlying Error object that triggered the unexpected error, if applicable.
NotificationContent
enum NotificationContent
The content of a notification, varying based on the type of the notification. The actual content is in the enum associated value, and may be nil.
case sms(SMSContent?)The content of an SMS notification.
case push(PushContent?)The content of a push notification.
case email(EmailContent?)The content of an email notification.
var type: NotificationType { get }The notification type.
struct MyDataHelpsKit.NotificationContent.SMSContent : DecodableThe content of an SMS notification.
struct MyDataHelpsKit.NotificationContent.PushContent : DecodableThe content of a push notification.
struct MyDataHelpsKit.NotificationContent.EmailContent : DecodableThe content of an email notification.
NotificationType
enum NotificationType : String, Decodable
The type of notification sent to a participant.
case sms = "Sms"SMS (text message) notification.
case push = "Push"Push notification sent to a mobile app.
case email = "Email"Email.
