FSInviteHandler Protocol Reference

Conforms to NSObject
Declared in FSInviteHandler.h

Overview

The FSInviteHandler protocol is adopted by an object that handles the display and dismissal of an invite view controller.

– show required method

Tells the invite handler to show a survey.

- (void)show

Declared In

FSInviteHandler.h

– hideWithAnimation: required method

Tells the invite handler to hide a survey.

- (void)hideWithAnimation:(BOOL)animate

Parameters

animate

A boolean indicating whether to animate the dismissal

Declared In

FSInviteHandler.h

– setInvalidInput:

Tells the invite handler whether the input is valid

- (void)setInvalidInput:(BOOL)isInvalid

Parameters

isInvalid

A boolean. YES, if the input is invalid; NO, otherwise

Declared In

FSInviteHandler.h

– show:domainWhitelist:title:

Tells the invite handler to load a URL

- (void)show:(NSURL *)url domainWhitelist:(NSSet *)domainWhitelist title:(NSString *)title

Parameters

url

The URL to load

domainWhitelist

A set of URLs that are legal to follow. This parameter is ignored unless enabledWhitelist is set to true in the configuration file.

title

The title of the page to load

Discussion

The default invites use this method to load links in a new page. Custom invites need not implement at this time.

Declared In

FSInviteHandler.h