SFSDKAuthHelper Class Reference

Inherits from NSObject
Declared in SFSDKAuthHelper.h

+ loginIfRequired:

Initiate a login flow if the user is not already logged in to Salesforce and if the app config’s shouldAuthenticate flag is set to false.

+ (void)loginIfRequired:(nullable void ( ^ ) ( void ))completionBlock

Parameters

completionBlock

Block that executes immediately if the user is already logged in, or if the app config’s shouldAuthenticate is set to false. Otherwise, this block executes after the user logs in successfully, if login is required.

Declared In

SFSDKAuthHelper.h

+ loginIfRequired:completion:

Initiate a login flow if the user is not already logged in to Salesforce and if the app config’s shouldAuthenticate flag is set to false.

+ (void)loginIfRequired:(UIScene *)scene completion:(nullable void ( ^ ) ( void ))completionBlock

Parameters

scene

Scene that login is initiated for.

completionBlock

Block that executes immediately if the user is already logged in, or if the app config’s shouldAuthenticate is set to false. Otherwise, this block executes after the user logs in successfully, if login is required.

Declared In

SFSDKAuthHelper.h

+ loginIfRequired:frontDoorBridgeUrl:codeVerifier:completion:

Initiate a login flow if the user is not already logged in to Salesforce and if the app config’s shouldAuthenticate flag is set to false.

+ (void)loginIfRequired:(nullable UIScene *)scene frontDoorBridgeUrl:(nullable NSURL *)frontDoorBridgeUrl codeVerifier:(nullable NSString *)codeVerifier completion:(void ( ^ ) ( void ))completionBlock

Parameters

scene

Scene that login is initiated for.

frontDoorBridgeUrl

Optionally, a Salesforce Identity API front door bridge URL to use in place of the default log in URL

codeVerifier

Optionally and only with the front door bridge URL parameter, a code verifier to use when the front door bridge URL is using web server authentication

completionBlock

Block that executes immediately if the user is already logged in or if the app config’s shouldAuthenticate is set to false. Otherwise, this block executes after the user logs in successfully if login is required.

Discussion

Parameters here include support for an optional overriding Salesforce Identity UI Bridge API front door bridge URL with an optional overriding code verifier. These override the default login URL to load and the default code verifier that would be generated for it when web server authentication is enabled. One use case for this is automatic login from a front door bridge URL provided as part of a QR code log in set up.

Declared In

SFSDKAuthHelper.h

+ handleLogout:

+ (void)handleLogout:(nullable void ( ^ ) ( void ))completionBlock

+ handleLogout:completion:

+ (void)handleLogout:(UIScene *)scene completion:(nullable void ( ^ ) ( void ))completionBlock

+ registerBlockForCurrentUserChangeNotifications:

+ (void)registerBlockForCurrentUserChangeNotifications:(void ( ^ ) ( void ))completionBlock

+ registerBlockForCurrentUserChangeNotifications:completion:

+ (void)registerBlockForCurrentUserChangeNotifications:(UIScene *)scene completion:(void ( ^ ) ( void ))completionBlock

+ registerBlockForLogoutNotifications:

+ (void)registerBlockForLogoutNotifications:(void ( ^ ) ( void ))completionBlock

+ registerBlockForLogoutNotifications:completion:

+ (void)registerBlockForLogoutNotifications:(UIScene *)scene completion:(void ( ^ ) ( void ))completionBlock

+ registerBlockForSwitchUserNotifications:

+ (void)registerBlockForSwitchUserNotifications:(void ( ^ ) ( void ))completionBlock