Optional setup

The AffiseSettings builder (returned by Affise.Settings(...), Runtime/Affise.cs:41) exposes chainable methods for fine-tuning the initialization behavior before Start().

AffiseSettings builder

Class: public sealed class AffiseSettings (Runtime/Settings/AffiseSettings.cs:9).

| Method | File:line | Purpose | |---|---|---| | SetProduction(bool production) | Runtime/Settings/AffiseSettings.cs:40 | Toggle production mode (default true, line 16). Set false to enable debug APIs. | | SetDomain(string domain) | Runtime/Settings/AffiseSettings.cs:50 | Override tracking domain; trailing slash is irrelevant. Default: https://tracking.affattr.com/ (Runtime/Network/CloudConfig.cs:10). | | SetPartParamName(string partParamName) | Runtime/Settings/AffiseSettings.cs:59 | Partner parameter name. | | SetPartParamNameToken(string partParamNameToken) | Runtime/Settings/AffiseSettings.cs:68 | Partner parameter token. | | SetAppToken(string appToken) | Runtime/Settings/AffiseSettings.cs:77 | Application token. | | SetOnInitSuccess(OnInitSuccessHandler) | Runtime/Settings/AffiseSettings.cs:86 | Success callback. | | SetOnInitError(OnInitErrorHandler) | Runtime/Settings/AffiseSettings.cs:95 | Error callback. | | SetConfigValue(AffiseConfig key, Object value) | Runtime/Settings/AffiseSettings.cs:104 | Single typed configuration entry. | | SetConfigValues(Dictionary<AffiseConfig, Object>) | Runtime/Settings/AffiseSettings.cs:113 | Bulk configuration entries. | | SetDisableModules(List<AffiseModules>) | Runtime/Settings/AffiseSettings.cs:126 | Disable specific modules at runtime. | | Start() | Runtime/Settings/AffiseSettings.cs:172 | Finalize configuration and boot the SDK. |

AffiseInitProperties

Backing DTO produced by the builder — public class AffiseInitProperties (Runtime/Init/AffiseInitProperties.cs:13).

| Field | Type | Default | |---|---|---| | AffiseAppId | string | required constructor argument (line 15) | | SecretKey | string | required constructor argument (line 17) | | PartParamName | string? | null (line 19) | | PartParamNameToken | string? | null (line 21) | | AppToken | string? | null (line 23) | | IsProduction | bool | true (line 25, ctor default line 45) | | OnInitSuccessHandler | OnInitSuccessHandler? | null (line 27) | | OnInitErrorHandler | OnInitErrorHandler? | null (line 29) | | ConfigValues | Dictionary<AffiseConfig, Object> | empty dictionary (line 31) | | DisableModules | List<AffiseModules> | empty list (line 34) | | Domain | string? | null (line 40) |

Public method Copy() returns a duplicate AffiseInitProperties (Runtime/Init/AffiseInitProperties.cs:129); ToJson property yields the JSONObject (line 131).

Custom domain

Domain override uses SetDomain(string):

Affise
    .Settings(
        affiseAppId: "Your appId",
        secretKey: "Your SDK secretKey"
    )
    .SetDomain("https://YoureCustomDomain/") // Set custom domain
    .Start(); // Start Affise SDK

Init success / error callbacks

Delegate types:

• public delegate void OnInitSuccessHandler(); (Runtime/Settings/OnInitSuccessHandler.cs:3)
• public delegate void OnInitErrorHandler(string error); (Runtime/Settings/OnInitErrorHandler.cs:3)

Wired via SetOnInitSuccess (Runtime/Settings/AffiseSettings.cs:86) and SetOnInitError (Runtime/Settings/AffiseSettings.cs:95).

Example (from; README mislabels the fence as dart, content is valid C#):

Affise
    .Settings(
        affiseAppId: "Your appId",
        secretKey: "Your SDK secretKey"
    )
    .SetOnInitSuccess(() => {
        Debug.Log("Affise: init success");
    })
    .SetOnInitError((error) => {
        Debug.Log($"Affise: init error {error}");
    })
    .Start(); // Start Affise SDK

Behavior (Runtime/Affise.cs:46-71):

• On a duplicate Start() call the error handler is invoked with AffiseError.MESSAGE_ALREADY_INITIALIZED.
• In the Editor path, OnInitSuccess is invoked after AffiseComponent constructs successfully; a thrown exception routes to OnInitError with e.StackTrace.
• On device, the native bridge constructs AffiseNative; the Unity-side success handler is not invoked explicitly in Runtime/Affise.cs.

Disable modules

Use SetDisableModules(List<AffiseModules>) to turn off bundled modules. Example:

Affise
    .Settings(
        affiseAppId: "Your appId",
        secretKey: "Your SDK secretKey",
    )
    .SetDisableModules(new List<AffiseModules> {
        AffiseModules.Persistent, // Disable module programmatically for iOS
        AffiseModules.AndroidId, // Disable module programmatically for Android
    })
    .Start();

See Modules for per-module effects.

Debug mode

Debug methods do not run in production

Affise.Debug.Validate(...), Network(...) and the rest of IAffiseDebugApi only return real data when production is set to false. On production builds they short-circuit (Validate returns ValidationStatus.NOT_WORKING_ON_PRODUCTION). Validate credentials before flipping production back to true.

Setting production false enables debug APIs accessible via Affise.Debug (typed IAffiseDebugApi, Runtime/Affise.cs:263):

Affise
    .Settings(
        affiseAppId: "Your appId",
        secretKey: "Your SDK secretKey"
    )
    .SetProduction(false) //To enable debug methods set Production to false
    .Start(); // Start Affise SDK

Affise.Debug.Validate(status =>
{
    // Handle validation status
});

IAffiseDebugApi (Runtime/Debugger/IAffiseDebugApi.cs:7):

| Method | File:line | |---|---| | Validate(DebugOnValidateCallback) | line 14 | | Network(DebugOnNetworkCallback) | line 21 | | Version() → string | line 26 | | VersionNative() → string? | line 31 |

Version() returns "1.7.7" (Runtime/Debugger/AffiseDebug.cs:51).

Enum ValidationStatus (Runtime/Debugger/Validate/ValidationStatus.cs:6) — VALID, INVALID_APP_ID, INVALID_SECRET_KEY, PACKAGE_NAME_NOT_FOUND, NOT_WORKING_ON_PRODUCTION, NETWORK_ERROR, UNKNOWN_ERROR.

Caution

README’s SDK validation list omits UNKNOWN_ERROR; the actual enum includes it at Runtime/Debugger/Validate/ValidationStatus.cs:14.

Troubleshooting

iOS: pod install fails on AffiseInternal

CocoaPods version mismatch

If pod install fails with CocoaPods could not find compatible versions for pod "AffiseInternal", run pod repo update and then pod install again. The local CocoaPods spec cache is stale.

If a Podfile has not been generated, copy Editor/Resources/iOS/AffisePodfile.rb as a starting template.

Settings or API behaving unexpectedly

Restart and clear caches

If Affise settings don’t change after edits, or the API behaves incorrectly:

1. Completely stop the mobile application on the device (force-quit, not just background).
2. Reset cache for the project (Unity Library/ clear, Xcode derived-data wipe, Gradle clean) and rebuild.

iOS crash: NSUserTrackingUsageDescription missing

Add the privacy key

If the app crashes with This app has crashed because Affise Advertising Module is attempted to access privacy-sensitive data without a usage description, add the NSUserTrackingUsageDescription key to Info.plist with a string value explaining how the app uses tracking. The key is required whenever the Advertising module is enabled.

Android 14 (API 34) crash: RECEIVER_EXPORTED

Update Unity for Android 14 receiver flags

On Android 14 (API level 34) the app crashes with:

java.lang.SecurityException: One of RECEIVER_EXPORTED or RECEIVER_NOT_EXPORTED should be specified when a receiver isn't being registered exclusively for system broadcasts

Cause: Google enforced a new security policy at API 34. Fix: upgrade Unity to 2023.3.0a4, 2022.3.14f1, or 2021.3.33f1 (or newer). Earlier Unity versions are not supported. See the related Unity issue.