SOSOnboardingViewController Protocol Reference
Conforms to | NSObject |
---|---|
Declared in | SOSOnboardingBaseViewController.h |
Overview
Protocol which defines properties and methods which are required for all view controllers which will accommodate the role for onboarding in SOS.
Alerts
– willHandleConnectionPrompt
required method
This method determines whether this view controller will handle a connection request prompt. Default is YES
.
If this method returns NO
then the SOS backend will directly proceed to the connection phase.
- (BOOL)willHandleConnectionPrompt
Return Value
Whether this view controller will handle a connection prompt.
Discussion
Return NO
if you do not wish to display a pre-connection onboarding screen for SOS sessions. If this method returns NO
your class will not receive a [SOSOnboardingViewController connectionPromptRequested]
call.
Declared In
SOSOnboardingBaseViewController.h
– connectionPromptRequested
required method
This method will be executed on the SOSOnboardingViewController
when the SOS backend has requested a user response.
At this point it is appropriate to display a UI element which will allow a user to confirm or cancel.
- (void)connectionPromptRequested
Discussion
The SOS backend will wait until it receives an appropriate response. Your UI element must trigger either:
[SOSOnboardingBaseViewController handleStartSession:]
or
[SOSOnboardingBaseViewController handleCancel:]
.
See Also
[SOSOnboardingViewController willHandleConnectionPrompt]
Declared In
SOSOnboardingBaseViewController.h