SFSDKAppConfig Class Reference

Inherits from	NSObject
Declared in	SFSDKAppConfig.h

Overview

Contains this app’s OAuth configuration as defined in the developer’s Salesforce connected app.

`remoteAccessConsumerKey`

The Connected App key associated with this application.

@property (nonatomic, copy) NSString *remoteAccessConsumerKey

Declared In

SFSDKAppConfig.h

`oauthRedirectURI`

The OAuth Redirect URI associated with the configured Connected Application.

@property (nonatomic, copy) NSString *oauthRedirectURI

Declared In

SFSDKAppConfig.h

`oauthScopes`

The OAuth Scopes being requested for this app.

@property (nonatomic, strong) NSSet<NSString*> *oauthScopes

Declared In

SFSDKAppConfig.h

`)`

Whether or not this app should authenticate when it first starts.

@property (nonatomic, assign) BOOL shouldAuthenticate NS_SWIFT_NAME ( shouldAuthenticateOnFirstLaunch )

Declared In

SFSDKAppConfig.h

`configDict`

The config as a dictionary

@property (nonatomic, strong) NSMutableDictionary *configDict

Declared In

SFSDKAppConfig.h

`– initWithDict:`

Initializer with a given JSON-based configuration dictionary.

- (nullable instancetype)initWithDict:(nullable NSDictionary *)configDict

Parameters

`configDict`	The dictionary containing the configuration.

Declared In

SFSDKAppConfig.h

`– initWithConfigFile:`

Initializer with a given a config file.

- (nullable instancetype)initWithConfigFile:(NSString *)configFile

Parameters

`configFile`	The path to config file

Declared In

SFSDKAppConfig.h

`– validate:`

Validate the app config inputs.

- (BOOL)validate:(NSError *_Nullable *_Nullable)error

Parameters

`error`	The error associated with validation, if an error occurs.

Return Value

YES if validation was successful, NO otherwise.

Declared In

SFSDKAppConfig.h

`+ fromDefaultConfigFile`

The app config from the default configuration file location.

+ (nullable instancetype)fromDefaultConfigFile

Return Value

The app config from the default configuration file location.

Declared In

SFSDKAppConfig.h

`+ fromConfigFile:`

Create an app config from the config file at the specified file path.

+ (nullable instancetype)fromConfigFile:(NSString *)configFilePath

Parameters

`configFilePath`	The file path to the configuration file, relative to the resources root path.

Return Value

The app config from the given file path.

Declared In

SFSDKAppConfig.h