MiniAppSdkConfig

public class MiniAppSdkConfig

MiniAppSdkConfig class helps you to configure the endpoints at runtime.

  • Preview mode (Mini app won’t be stored in local)

    Declaration

    Swift

    public var isPreviewMode: Bool?

  • Bool used to verifty Mini app signature after download is complete

    Declaration

    Swift

    public var requireMiniAppSignatureVerification: Bool?

  • Max size in bytes for secure storage

    Declaration

    Swift

    public var storageMaxSizeInBytes: UInt64?

  • Base Endpoint URL

    Declaration

    Swift

    public var baseUrl: String? { get set }

  • Host/Domain name which is retrieved from Base URL

    Declaration

    Swift

    public var host: String? { get }

  • MiniAppConfigSSLKeyHash config object

    Declaration

    Swift

    public var sslKeyHash: MiniAppConfigSSLKeyHash? { get set }

  • Project ID that is associated with the mini app

    Declaration

    Swift

    public var rasProjectId: String? { get set }

  • Subscription Key that is associated with the mini app

    Declaration

    Swift

    public var subscriptionKey: String? { get set }

  • Optional - Host app version for e.g, 1.0

    Declaration

    Swift

    public var hostAppVersion: String? { get set }

  • Array of MAAnalyticsConfig that is used to send impressions

    Declaration

    Swift

    public var analyticsConfigList: [MAAnalyticsConfig]? { get set }

  • Initialize a MiniAppSdkConfig object that can be used to configure a MiniApp client. All the parameters are optional. If a parameter is omitted the client will fallback its value to the configuration values provided into the project configuration .plist

    Declaration

    Swift

    public init(baseUrl: String? = nil,
            rasProjectId: String? = nil,
            subscriptionKey: String? = nil,
            hostAppVersion: String? = nil,
            isPreviewMode: Bool? = nil,
            analyticsConfigList: [MAAnalyticsConfig]? = [],
            requireMiniAppSignatureVerification: Bool? = nil,
            sslKeyHash: MiniAppConfigSSLKeyHash? = nil,
            storageMaxSizeInBytes: UInt64? = nil)

    Parameters

    baseUrl

    The production URL of the API endpoint
    rasProjectId

    The Rakuten Studio Host App Project ID
    subscriptionKey

    The Rakuten Studio Subscription Key
    hostAppVersion

    The Rakuten Studio Host App version
    isPreviewMode

    A boolean used by MiniApp SDK to determine which endpoint to use. Default is true
    requireMiniAppSignatureVerification

    A boolean used by MiniApp SDK to determine if you prevent man in the middle attack during MiniApp launch. Default is false
    sslKeyHash

    A SSL pin and backup pin used for SSL pinning