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.

decodingError(_:)
case decodingError(Error)

Failure to decode a model object.

encodingError(_:)
case encodingError(Error)

Failure to encode a model object.

serverError(_:)
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.

tooManyRequests(_: _:)
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.

timedOut(_:)
case timedOut(Error)

A server request timed out.

unauthorizedRequest(_:)
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.

webContentError(_:)
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.

unknown(_:)
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.

sms(_:)
case sms(SMSContent?)

The content of an SMS notification.

push(_:)
case push(PushContent?)

The content of a push notification.

email(_:)
case email(EmailContent?)

The content of an email notification.

type
var type: NotificationType { get }

The notification type.

SMSContent
struct MyDataHelpsKit.NotificationContent.SMSContent : Decodable

The content of an SMS notification.

PushContent
struct MyDataHelpsKit.NotificationContent.PushContent : Decodable

The content of a push notification.

EmailContent
struct MyDataHelpsKit.NotificationContent.EmailContent : Decodable

The content of an email notification.

NotificationType

enum NotificationType : String, Decodable

The type of notification sent to a participant.

sms
case sms = "Sms"

SMS (text message) notification.

push
case push = "Push"

Push notification sent to a mobile app.

email
case email = "Email"

Email.