Skip to content

GitHub X LinkedIn

Select theme

Select language

Guides
Developers
SDK Reference

Overview
Core SDK
- actions
- index
React SDK
- functions
- type-aliases
  - FrakConfigProviderProps
  - FrakIFrameClientProps
Web Components
- functions
- interfaces
- type-aliases
Android
- Android SDK
- id-frak-sdk
  - id.frak.sdk
  - AppLinkApi
    AppLinkApi
    handleReferral
    handleReferralAsync
    installPageUrl
    installPageUrlAsync
    isFrakAppInstalled
    openFrakApp
    openFrakAppAsync
  - ConfigApi
    ConfigApi
    resolve
    resolveAsync
  - frak
    Frak
    client
    clientOrNull
    initialize
    isInitialized
    parseReferralLink
    shutdown
    shutdownAsync
  - FrakClient
    FrakClient
    anonymousId
    anonymousIdAsync
    appLink
    config
    environment
    isTrackingEnabled
    isTrackingEnabledAsync
    metadataLang
    metadataName
    resetAnonymousId
    resetAnonymousIdAsync
    rewards
    setTrackingEnabled
    setTrackingEnabledAsync
    sharing
    tracking
  - FrakSdkVersion
    FrakSdkVersion
    CURRENT
    HEADER_NAME
    HEADER_VALUE
    QUERY_PARAMETER_NAME
  - InternalFrakApi
    InternalFrakApi
  - OpenAppResult
    OpenAppResult
    Failed
    Failed
    OpenedApp
    OpenedApp
    OpenedStore
    OpenedStore
    valueOf
    values
  - RewardsApi
    RewardsApi
    best
    bestAsync
    campaigns
    campaignsAsync
  - SharingApi
    SharingApi
    buildLink
    buildLinkAsync
  - TrackingApi
    TrackingApi
    purchase
    purchaseAsync
    track
    trackAsync
- id-frak-sdk-config
  - id.frak.sdk.config
  - AttributionDefaults
    AttributionDefaults
    ref
    utmCampaign
    utmMedium
    utmSource
    utmTerm
    via
  - BannerConfig
    BannerConfig
    imageUrl
    inappCta
    inappDescription
    inappTitle
    referralCta
    referralDescription
    referralTitle
  - ButtonShareConfig
    ButtonShareConfig
    clickAction
    noRewardText
    text
  - ButtonWalletConfig
    ButtonWalletConfig
    position
  - FrakResolvedConfig
    FrakResolvedConfig
    currency
    displayLogoUrl
    displayName
    domain
    hidden
    lang
    merchantId
    name
    sdkConfig
  - OpenInAppConfig
    OpenInAppConfig
    text
  - PostPurchaseConfig
    PostPurchaseConfig
    badgeText
    ctaNoRewardText
    ctaText
    imageUrl
    refereeNoRewardText
    refereeText
    referrerNoRewardText
    referrerText
  - ResolvedComponents
    ResolvedComponents
    banner
    buttonShare
    buttonWallet
    openInApp
    postPurchase
  - ResolvedPlacement
    ResolvedPlacement
    components
    targetInteraction
    translations
  - ResolvedSdkConfig
    ResolvedSdkConfig
    attribution
    components
    currency
    hidden
    homepageLink
    lang
    logoUrl
    name
    placements
    translations
- id-frak-sdk-core
  - id.frak.sdk.core
  - DeepLinkHandling
    DeepLinkHandling
    Automatic
    Automatic
    Disabled
    Disabled
    Manual
    Manual
    valueOf
    values
  - FrakConfig
    FrakConfig
    Builder
    Builder
    build
    Builder
    deepLink
    env
    logLevel
    logSink
    merchantId
    metadata
    packageId
    trackingEnabled
    deepLink
    env
    logLevel
    logSink
    merchantId
    metadata
    packageId
    trackingEnabled
  - FrakConfig()
  - FrakCurrency
    FrakCurrency
    EUR
    EUR
    GBP
    GBP
    USD
    USD
    valueOf
    values
    wireValue
  - FrakEnvironment
    FrakEnvironment
    backend
    Custom
    Custom
    backend
    Custom
    wallet
    walletPackageId
    walletScheme
    Development
    Development
    backend
    wallet
    Production
    Production
    backend
    wallet
    walletPackageId
    walletScheme
    wallet
    walletPackageId
    walletScheme
  - FrakError
    FrakError
    AlreadyPresenting
    AlreadyPresenting
    AlreadyPresenting
    BackingOff
    BackingOff
    BackingOff
    retryAfterSeconds
    Decoding
    Decoding
    Decoding
    InternalFailure
    InternalFailure
    InternalFailure
    Kind
    Kind
    ALREADY_PRESENTING
    ALREADY_PRESENTING
    BACKING_OFF
    BACKING_OFF
    DECODING
    DECODING
    INTERNAL_FAILURE
    INTERNAL_FAILURE
    MERCHANT_RESOLUTION_FAILED
    MERCHANT_RESOLUTION_FAILED
    NETWORK
    NETWORK
    NOT_INITIALIZED
    NOT_INITIALIZED
    SERVER
    SERVER
    TRACKING_DISABLED
    TRACKING_DISABLED
    valueOf
    values
    wireValue
    kind
    MerchantResolutionFailed
    MerchantResolutionFailed
    MerchantResolutionFailed
    Network
    Network
    Network
    NotInitialized
    NotInitialized
    NotInitialized
    Server
    Server
    code
    retryAfterSeconds
    Server
    status
    TrackingDisabled
    TrackingDisabled
    TrackingDisabled
  - FrakLanguage
    FrakLanguage
    EN
    EN
    FR
    FR
    valueOf
    values
    wireValue
  - FrakLogLevel
    FrakLogLevel
    DEBUG
    DEBUG
    ERROR
    ERROR
    INFO
    INFO
    NONE
    NONE
    valueOf
    values
    WARN
    WARN
  - FrakLogSink
    FrakLogSink
    log
  - FrakMetadata
    FrakMetadata
    Builder
    Builder
    build
    Builder
    currency
    homepageLink
    lang
    logoUrl
    name
    currency
    homepageLink
    lang
    logoUrl
    name
  - FrakMetadata()
  - FrakResult
    FrakResult
    Failure
    Failure
    error
    Failure
    Success
    Success
    Success
    value
  - ProductDetails
    ProductDetails
    Builder
    Builder
    build
    Builder
    name
    productId
    quantity
    sku
    totalPrice
    unitPrice
    name
    productId
    quantity
    sku
    totalPrice
    unitPrice
  - ProductDetails()
- id-frak-sdk-net
  - id.frak.sdk.net
  - PercentEncoding
    PercentEncoding
    encode
- id-frak-sdk-rewards
  - id.frak.sdk.rewards
  - BestReward
    BestReward
    BestReward
    formatted
    isProductScoped
    lockupDurationDays
    matchedProducts
    minPurchaseAmount
    minPurchaseValue
    payoutType
  - campaign
    Campaign
    Campaign
    campaignId
    defaultLockupSeconds
    expiresAt
    interactionTypeKey
    maxRewardsPerUser
    name
    referee
    referrer
  - EstimatedReward
    EstimatedReward
    Fixed
    Fixed
    amount
    Fixed
    Percentage
    Percentage
    maxAmount
    minAmount
    percent
    Percentage
    percentOf
    Tiered
    Tiered
    Tiered
    tierField
    tiers
    Unknown
    Unknown
    payoutType
    Unknown
  - RewardAudience
    RewardAudience
    REFEREE
    REFEREE
    REFERRER
    REFERRER
    valueOf
    values
    wireValue
  - RewardRequest
    RewardRequest
    audience
    Builder
    Builder
    addProduct
    audience
    build
    Builder
    products
    targetInteraction
    products
    targetInteraction
  - RewardRequest()
  - RewardTier
    RewardTier
    Amount
    Amount
    Amount
    amount
    maxValue
    minValue
    maxValue
    minValue
    Percentage
    Percentage
    maxValue
    minValue
    percent
    Percentage
    Unknown
    Unknown
    maxValue
    minValue
    Unknown
  - TokenAmount
    TokenAmount
    amount
    eurAmount
    gbpAmount
    TokenAmount
    usdAmount
- id-frak-sdk-sharing
  - id.frak.sdk.sharing
  - AttributionParams
    AttributionParams
    Builder
    Builder
    build
    Builder
    ref
    utmCampaign
    utmContent
    utmMedium
    utmSource
    utmTerm
    via
    ref
    utmCampaign
    utmContent
    utmMedium
    utmSource
    utmTerm
    via
  - AttributionParams()
  - FrakContext
    FrakContext
    V1
    V1
    wallet
    V2
    V2
    clientId
    merchantId
    timestamp
    wallet
  - SharingProduct
    SharingProduct
    Builder
    Builder
    build
    Builder
    details
    imageUrl
    utmContent
    details
    imageUrl
    link
    title
    utmContent
  - SharingProduct()
  - SharingRequest
    SharingRequest
    attribution
    Builder
    Builder
    addProduct
    attribution
    build
    Builder
    link
    logoUrl
    placement
    products
    shareImageUrl
    shareText
    shareTitle
    targetInteraction
    link
    logoUrl
    placement
    products
    shareImageUrl
    shareText
    shareTitle
    targetInteraction
  - SharingRequest()
- id-frak-sdk-tracking
  - id.frak.sdk.tracking
  - interaction
    Interaction
    companion
    Companion
    arrival
    custom
    sharing
- id-frak-sdk-ui
  - id.frak.sdk.ui
  - FrakSharing
    FrakSharing
    Builder
    Builder
    build
    Builder
    heightFraction
    language
    present
    ResultCallback
    ResultCallback
    onResult
    warm
  - FrakSharingDefaults
    FrakSharingDefaults
    HEIGHT_FRACTION
  - SharingResult
    SharingResult
    Copied
    Copied
    Copied
    kind
    link
    Dismissed
    Dismissed
    kind
    Failed
    Failed
    error
    Failed
    kind
    InstallStarted
    InstallStarted
    kind
    Kind
    Kind
    COPIED
    COPIED
    DISMISSED
    DISMISSED
    FAILED
    FAILED
    INSTALL_STARTED
    INSTALL_STARTED
    SHARED
    SHARED
    valueOf
    values
    WALLET_OPENED
    WALLET_OPENED
    wireValue
    kind
    Shared
    Shared
    kind
    link
    Shared
    WalletOpened
    WalletOpened
    kind
iOS
- iOS SDK
- FrakSDK
  - FrakSDK
  - AppLinkAPI
    AppLinkAPI
  - AttributionDefaults
    AttributionDefaults
  - AttributionParams
    AttributionParams
  - BannerConfig
    BannerConfig
  - BestReward
    BestReward
  - ButtonShareConfig
    ButtonShareConfig
  - ButtonWalletConfig
    ButtonWalletConfig
  - Campaign
    Campaign
  - ConfigAPI
    ConfigAPI
  - DeepLinkHandling
    DeepLinkHandling
  - EstimatedReward
    EstimatedReward
  - Frak
    Frak
  - FrakClient
    FrakClient
  - FrakConfig
    FrakConfig
  - FrakContext
    FrakContext
    V2
    FrakContext.V2
  - FrakCurrency
    FrakCurrency
  - FrakEnvironment
    FrakEnvironment
  - FrakError
    FrakError
    Kind
    FrakError.Kind
  - FrakLanguage
    FrakLanguage
  - FrakLogLevel
    FrakLogLevel
  - FrakLogSink
    FrakLogSink
  - FrakMetadata
    FrakMetadata
  - FrakResolvedConfig
    FrakResolvedConfig
  - Interaction
    Interaction
  - OpenAppResult
    OpenAppResult
  - OpenInAppConfig
    OpenInAppConfig
  - PercentEncoding
    PercentEncoding
  - PostPurchaseConfig
    PostPurchaseConfig
  - ProductDetails
    ProductDetails
  - ResolvedComponents
    ResolvedComponents
  - ResolvedPlacement
    ResolvedPlacement
  - ResolvedSdkConfig
    ResolvedSdkConfig
  - RewardAudience
    RewardAudience
  - RewardRequest
    RewardRequest
  - RewardsAPI
    RewardsAPI
  - RewardTier
    RewardTier
  - SharingAPI
    SharingAPI
  - SharingProduct
    SharingProduct
  - SharingRequest
    SharingRequest
  - TokenAmount
    TokenAmount
  - TrackingAPI
    TrackingAPI
- FrakSDKUI
  - FrakSDKUI
  - FrakInstallPresentation
    FrakInstallPresentation
    Overlay
    FrakInstallPresentation.Overlay
    Position
    FrakInstallPresentation.Overlay.Position
  - FrakSharing
    FrakSharing
  - FrakSharingConfiguration
    FrakSharingConfiguration
  - FrakSharingDefaults
    FrakSharingDefaults
  - SharingResult
    SharingResult
    Kind
    SharingResult.Kind
  - View
    extension View

GitHub X LinkedIn

Select theme

Select language

On this page

Overview
Modules

iOS SDK

Modules

Section titled “Modules”

Name	Contents
FrakSDK	43 type(s)
FrakSDKUI	9 type(s)

Last updated: Sep 4, 2026