SCCameraKitSessionConfig

Objective-C


@interface SCCameraKitSessionConfig : NSObject

Swift

class SessionConfig : NSObject

Data class that is used to pass in a configuration for the CameraKit Session. Use this data class if you would like to be able to dynamically update config values like application id and api token or overwrite the ones that are passed into Info.plist.

  • API token that is found in the dev portal

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull apiToken;

    Swift

    var apiToken: String { get }

  • Warning

    USE ONLY AS DIRECTED BY SNAP SUPPORT.

    Declaration

    Objective-C

    @property (nonatomic, strong, readonly) NSDictionary<NSString *, id> *_Nonnull additionalConfigurationAttributes;

    Swift

    var additionalConfigurationAttributes: [String : Any] { get }

  • Designated init to pass in apiToken

    Note

    as well as overwrite the apiToken passed into Info.plist with the key SCCameraKitAPIToken

    Declaration

    Objective-C

    - (nonnull instancetype)initWithApiToken:(nonnull NSString *)apiToken;

    Swift

    init(apiToken: String)

    Parameters

    apiToken

    api token that is found in the dev portal

  • Init to pass in apiToken

    Note

    as well as overwrite the apiToken passed into Info.plist with the key SCCameraKitAPIToken

    Warning

    USE ONLY AS DIRECTED BY SNAP SUPPORT.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithApiToken:(nonnull NSString *)apiToken
       additionalConfigurationAttributes:
           (nullable NSDictionary<NSString *, id> *)
               additionalConfigurationAttributes;

    Swift

    convenience init(apiToken: String, additionalConfigurationAttributes: [String : Any]? = nil)

    Parameters

    apiToken

    api token that is found in the dev portal
    additionalConfigurationAttributes

    additional configuration

  • Unavailable

    Use designated init to pass in require applicationID and apiToken

    Declaration

    Objective-C

    + (nonnull instancetype)new;

  • Unavailable

    Undocumented

    Declaration

    Objective-C

    - (instancetype)init NS_UNAVAILABLE;

  • Deprecated

    Application ID-based authentication is no longer supported. Use apiToken instead.

    applicationID/clientID that is found in the dev portal

    Declaration

    Objective-C

    @property (nonatomic, copy, readonly) NSString *_Nonnull applicationId;

    Swift

    var applicationId: String { get }

  • Deprecated

    Application ID-based authentication is no longer supported. Use initWithApiToken: instead.

    Designated init to pass in applicationID and apiToken

    Note

    this will override the applicationID passed into Info.plist with the key SCCameraKitClientID

    Note

    as well as overwrite the apiToken passed into Info.plist with the key SCCameraKitAPIToken

    Declaration

    Objective-C

    - (nonnull instancetype)initWithApplicationID:(nonnull NSString *)applicationID
                                     apiToken:(nonnull NSString *)apiToken;

    Swift

    convenience init(applicationID: String, apiToken: String)

    Parameters

    applicationID

    applicationID/clientID that is found in the dev portal
    apiToken

    api token that is found in the dev portal

  • Deprecated

    Application ID-based authentication is no longer supported. Use initWithApiToken:additionalConfigurationAttributes: instead.

    Init to pass in applicationID and apiToken

    Note

    this will override the applicationID passed into Info.plist with the key SCCameraKitClientID

    Note

    as well as overwrite the apiToken passed into Info.plist with the key SCCameraKitAPIToken

    Warning

    USE ONLY AS DIRECTED BY SNAP SUPPORT.

    Declaration

    Objective-C

    - (nonnull instancetype)initWithApplicationID:(nonnull NSString *)applicationID
                                     apiToken:(nonnull NSString *)apiToken
            additionalConfigurationAttributes:
                (nullable NSDictionary<NSString *, id> *)
                    additionalConfigurationAttributes;

    Swift

    convenience init(applicationID: String, apiToken: String, additionalConfigurationAttributes: [String : Any]? = nil)

    Parameters

    applicationID

    applicationID/clientID that is found in the dev portal
    apiToken

    api token that is found in the dev portal
    additionalConfigurationAttributes

    additional configuration