SMICoreConfiguration

Objective-C


@interface SMICoreConfiguration : NSObject <NSCopying>

Swift

class Configuration : NSObject, NSCopying

This class stores configuration information that is necessary when creating an SMICoreClient instance using the SMICoreFactory class.

  • The base endpoint we are connecting to for all API requests.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSURL *_Nonnull serviceAPI;

    Swift

    var serviceAPI: URL { get }

  • The 15 character Salesforce org ID.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString *_Nonnull organizationId;

    Swift

    var organizationId: String { get }

  • The API Name for the embedded service deployment associated with this configuration.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSString *_Nonnull developerName;

    Swift

    var developerName: String { get }

  • Used to provide mapping from device locale to a specific language when retrieving localized copy for the current deployment. This currently impacts only localized strings as part of the RemoteConfiguration response.

    Example If you want to avoid having to define region specific variants of custom labels, you can define a dictionary which maps locales to a language. { “en-CA”: “en”, “fr-Fr”: “fr”, “fr-CH”: “fr”, “default:” “en” }

    The map above will resolve standard English for the Canadian region, and standard French for France and Switzerland. Both the keys and values are case insensitive. The default key can be used as a fallback incase any of the mapped languages are not properly resolved in the deployment setup.

    See

    https://help.salesforce.com/s/articleView?id=sf.faq_getstart_what_languages_does.htm&type=5

    See

    SMIRemoteConfiguration

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly, nullable) NSDictionary<NSString *, NSString *> *remoteLocaleMap;

    Swift

    var remoteLocaleMap: [String : String]? { get }

  • Indicates whether this configuration requires user verification.

    Declaration

    Objective-C

    @property (nonatomic, assign, unsafe_unretained, readonly,
          getter=isUserVerificationRequired) BOOL userVerificationRequired;

    Swift

    var isUserVerificationRequired: Bool { get }

  • Unavailable

    This constructor is not available.

    Declaration

    Objective-C

    - (nonnull instancetype)init;

  • Creates a configuration object that can be used to instantiate an SMICoreClient object using SMICoreFactory.

    Declaration

    Objective-C

    - (nullable instancetype)initWithURL:(nonnull NSURL *)url;

    Swift

    convenience init?(url: URL)

    Parameters

    url

    The URL to the JSON config file.

  • Creates a configuration object that can be used to instantiate an SMICoreClient object using SMICoreFactory.

    Declaration

    Objective-C

    - (nullable instancetype)initWithURL:(nonnull NSURL *)url
            userVerificationRequired:(BOOL)userVerificationRequired;

    Swift

    convenience init?(url: URL, userVerificationRequired: Bool)

    Parameters

    url

    The URL to the JSON config file.
    userVerificationRequired

    Whether or not authorization connections are intended to be configured for User Verification.

  • Creates a configuration object that can be used to instantiate an SMICoreClient object using SMICoreFactory.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithServiceAPI:(nonnull NSURL *)serviceAPI
                            organizationId:(nonnull NSString *)organizationId
                             developerName:(nonnull NSString *)developerName;

    Swift

    convenience init(serviceAPI: URL, organizationId: String, developerName: String)

    Parameters

    serviceAPI

    The base endpoint we are connecting to for all API requests.
    organizationId

    The Salesforce org ID.
    developerName

    The API Name for the embedded service deployment associated with this configuration.

  • Creates a configuration object that can be used to instantiate an SMICoreClient object using SMICoreFactory.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithServiceAPI:(nonnull NSURL *)serviceAPI
                            organizationId:(nonnull NSString *)organizationId
                             developerName:(nonnull NSString *)developerName
                  userVerificationRequired:(BOOL)userVerificationRequired;

    Swift

    convenience init(serviceAPI: URL, organizationId: String, developerName: String, userVerificationRequired: Bool)

    Parameters

    serviceAPI

    The base endpoint we are connecting to for all API requests.
    organizationId

    The Salesforce org ID.
    developerName

    The API Name for the embedded service deployment associated with this configuration.
    userVerificationRequired

    Whether or not authorization connections are intended to be configured for User Verification.

  • Creates a configuration object that can be used to instantiate an SMICoreClient object using SMICoreFactory.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithServiceAPI:(nonnull NSURL *)serviceAPI
                            organizationId:(nonnull NSString *)organizationId
                             developerName:(nonnull NSString *)developerName
                           remoteLocaleMap:
                               (nullable NSDictionary<NSString *, NSString *> *)
                                   remoteLocaleMap
                  userVerificationRequired:(BOOL)userVerificationRequired;

    Swift

    init(serviceAPI: URL, organizationId: String, developerName: String, remoteLocaleMap: [String : String]?, userVerificationRequired: Bool)

    Parameters

    serviceAPI

    The base endpoint we are connecting to for all API requests.
    organizationId

    The Salesforce org ID.
    developerName

    The API Name for the embedded service deployment associated with this configuration.
    remoteLocaleMap

    The localization map used for resolving the language for custom labels returned when requesting an SMIRemoteConfiguration
    userVerificationRequired

    Whether or not authorization connections are intended to be configured for User Verification.