VaultMobileSDK  18R3
iOS framework for Vault API
Instance Methods | Class Methods | List of all members
VEVSDKApplicationDelegate Class Reference

A singleton object with an interface that corresponds to Apple's UIApplicationDelegate protocol. These methods must be called from within the host application's UIApplicationDelegate in order to integrate properly with VaultMobileSDK. More...

Inherits NSObject.

Instance Methods

(BOOL) - application:didFinishLaunchingWithOptions:
 Called from the application's UIApplicationDelegate application:didFinishLaunchingWithOptions: in order to to finalize VaultMobileSDK's initialization. More...
 
(BOOL) - application:openURL:options:
 Called from the application's UIApplicationDelegate application:openURL:options: method to allow VaultMobileSDK to handle URL schemes that it is responsible for. More...
 
(void) - application:handleEventsForBackgroundURLSession:completionHandler:
 Forwards completionHandler to VaultMobileSDK in order to finalize any background session tasks managed by VaultMobileSDK. More...
 

Class Methods

(instancetype) + sharedInstance
 Return the singleton instance.
 

Detailed Description

A singleton object with an interface that corresponds to Apple's UIApplicationDelegate protocol. These methods must be called from within the host application's UIApplicationDelegate in order to integrate properly with VaultMobileSDK.

Method Documentation

◆ application:didFinishLaunchingWithOptions:()

- (BOOL) application: (UIApplication *)  application
didFinishLaunchingWithOptions: (NSDictionary *)  launchOptions 

Called from the application's UIApplicationDelegate application:didFinishLaunchingWithOptions: in order to to finalize VaultMobileSDK's initialization.

Parameters
applicationThe application object received by the app's UIApplicationDelegate.
launchOptionsThe launchOptions dictionary received by the app's UIApplicationDelegate.

◆ application:openURL:options:()

- (BOOL) application: (UIApplication *)  application
openURL: (NSURL *)  url
options: (NSDictionary< UIApplicationOpenURLOptionsKey, id > *)  options 

Called from the application's UIApplicationDelegate application:openURL:options: method to allow VaultMobileSDK to handle URL schemes that it is responsible for.

For example, this method must be invoked in order to properly enable authentication via OAuth.

Parameters
applicationThe application object received by the app's UIApplicationDelegate.
urlThe url object received by the app's UIApplicationDelegate.
optionsThe options dictionary received by the app's UIApplicationDelegate.
Returns
YES if the method handled the URL and no further processing is necessary, otherwise NO.

◆ application:handleEventsForBackgroundURLSession:completionHandler:()

- (void) application: (UIApplication *)  application
handleEventsForBackgroundURLSession: (NSString *)  identifier
completionHandler: (void(^)(void))  completionHandler 

Forwards completionHandler to VaultMobileSDK in order to finalize any background session tasks managed by VaultMobileSDK.

For example, this method must be invoked in order to properly handle background file uploads to Vault.

Parameters
applicationThe application object received by the app's UIApplicationDelegate.
identifierThe identifier received by the app's UIApplicationDelegate. This method will only track and invoke completionHandler if identifier matches the value expected by VaultMobileSDK (com.veeva.VaultMobileSDK.backgroundsession).
completionHandlerThe completionHandler received by the app's UIApplicationDelegate.
See also
UIApplication:application:handleEventsForBackgroundURLSession:completionHandler:
iPhone Programming Guide Background Execution

The documentation for this class was generated from the following file: