SCSDKLensLaunchDataBuilder

Objective-C

@interface SCSDKLensLaunchDataBuilder : NSObject

Swift

class SCSDKLensLaunchDataBuilder : NSObject

SCSDKLensLaunchDataBuilder class allows you to build launch data for a Lens attachment

  • @property lensLaunchData @brief Lens launch data attributes to be used in lens view

    Declaration

    Objective-C

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

    Swift

    var lensLaunchData: String { get }

  • adds a key value pair for lens launch data

    Declaration

    Objective-C

    - (void)addNSStringKeyPair:(nonnull NSString *)key
                     value:(nonnull NSString *)value;

    Swift

    func addNSStringKeyPair(_ key: String, value: String)

    Parameters

    key

    String key for lens launch data
    value

    String, int, float, or array of any of those types value for lens launch data

  • adds a key value pair for lens launch data

    Declaration

    Objective-C

    - (void)addNSNumberKeyPair:(nonnull NSString *)key
                     value:(nonnull NSNumber *)value;

    Swift

    func addNSNumberKeyPair(_ key: String, value: NSNumber)

    Parameters

    key

    String key for lens launch data
    value

    String, int, float, or array of any of those types value for lens launch data

  • adds a key value pair for lens launch data

    Declaration

    Objective-C

    - (void)addNSStringArrayKeyPair:(nonnull NSString *)key
                          value:(nonnull NSArray<NSString *> *)value;

    Swift

    func addNSStringArrayKeyPair(_ key: String, value: [String])

    Parameters

    key

    String key for lens launch data
    value

    String, int, float, or array of any of those types value for lens launch data

  • adds a key value pair for lens launch data

    Declaration

    Objective-C

    - (void)addNSNumberArrayKeyPair:(nonnull NSString *)key
                          value:(nonnull NSArray<NSNumber *> *)value;

    Swift

    func addNSNumberArrayKeyPair(_ key: String, value: [NSNumber])

    Parameters

    key

    String key for lens launch data
    value

    String, int, float, or array of any of those types value for lens launch data

  • Build the SCSDKLensLaunchData object and converts the NSMutable Dictionary to a JSON string for the lens

    Declaration

    Objective-C

    - (void)build;

    Swift

    func build()