FSInviteDelegate Protocol Reference

Conforms to	NSObject
Declared in	FSInviteDelegate.h

Overview

Delegates registered with the ForeSee SDK may adopt the FSInviteDelegate protocol to receive updates about a survey’s lifecycle.

Custom Surveys

`measure`	The measure for the survey that the user is about to be invited to take.

`measure`	The measure for which a survey is about to be displayed.

Sampling and Eligibility Checks

`– willNotShowInviteWithEligibilityFailedForMeasure:`

Sent when the customer does not pass the eligibility check for a survey.

- (void)willNotShowInviteWithEligibilityFailedForMeasure:(TRMeasure *)measure

Parameters

`measure`	The measure associated with this event.

Discussion

A user who is not eligible will not see an invite.

Declared In

FSInviteDelegate.h

`– willNotShowInviteWithSamplingFailedForMeasure:`

Sent when the customer was not included in the sampling pool check.

- (void)willNotShowInviteWithSamplingFailedForMeasure:(TRMeasure *)measure

Parameters

`measure`	The measure associated with this event.

Discussion

Not all users who are eligible are invited to take a survey. A sampling rate is configured for your account, which limits the total number of users who will see an invite. This method is called when the user was not in the sampling pool.

Declared In

FSInviteDelegate.h

Other Invite Events

`– didShowInviteForMeasure:`

Tells the delegate that the ForeSee SDK has shown an invite.

- (void)didShowInviteForMeasure:(TRMeasure *)measure

Parameters

`measure`	The measure associated with the invite that was displayed.

Discussion

Only called when using the built-in invites (i.e. not for custom invites). It’s assumed that custom invites already know when an invite has been shown.

Declared In

FSInviteDelegate.h

`– didAcceptInviteForMeasure:`

Tells the delegate that the user has accepted an invite.

- (void)didAcceptInviteForMeasure:(TRMeasure *)measure

Parameters

`measure`	The measure associated with the invite.

Declared In

FSInviteDelegate.h

`– didDeclineInviteForMeasure:`

Tells the delegate that the user has declined an invite.

- (void)didDeclineInviteForMeasure:(TRMeasure *)measure

Parameters

`measure`	The measure associated with the invite.

Declared In

FSInviteDelegate.h

Other Survey Events

`– didShowSurveyForMeasure:`

Tells the delegate that the ForeSee SDK has presented a survey.

- (void)didShowSurveyForMeasure:(TRMeasure *)measure

Parameters

`measure`	The measure for the survey that was displayed.

Discussion

Warning: Not sent for custom surveys

Declared In

FSInviteDelegate.h

`– didCancelSurveyForMeasure:`

Tells the delegate that the user cancelled a survey.

- (void)didCancelSurveyForMeasure:(TRMeasure *)measure

Parameters

`measure`	The measure for the survey that was dismissed.

Discussion

Warning: Not sent for custom surveys

Declared In

FSInviteDelegate.h

`– didCompleteSurveyForMeasure:`

Tells the delegate that the user completed a survey.

- (void)didCompleteSurveyForMeasure:(TRMeasure *)measure

Parameters

`measure`	The measure for the survey that was completed.

Discussion

Warning: Not sent for custom surveys

Declared In

FSInviteDelegate.h

Error Conditions

`– didFailForMeasure:withContactFormatError:`

Sent when the supplied contact information is not in the correct format.

- (void)didFailForMeasure:(TRMeasure *)measure withContactFormatError:(NSError *)error

Parameters

`measure`	The measure associated with this failure
`error`	An error object containing details about the formatting issue.

Discussion

This error prevents successful acceptance of an invite.

Declared In

FSInviteDelegate.h

`– didFailForMeasure:withMissingInformationError:`

Sent when the invite failed because of missing information.

- (void)didFailForMeasure:(TRMeasure *)measure withMissingInformationError:(NSError *)error

Parameters

`measure`	The measure associated with this failure
`error`	An error object containing details about the missing information.

Discussion

This error prevents successful acceptance of an invite.

Declared In

FSInviteDelegate.h

`– didFailForMeasure:withNetworkError:`

Sent when the invite or survey failed because of a network error.

- (void)didFailForMeasure:(TRMeasure *)measure withNetworkError:(NSError *)error

Parameters

`measure`	The measure associated with this failure
`error`	An error object containing details about the network failure.

Discussion

This error prevents successful acceptance or cancellation of an invite or survey.

Declared In

FSInviteDelegate.h