API reference
Every public method exposed by the Flutter SDK. Method signatures use the canonical language for the runtime; toggle between languages with the tab switcher where applicable.
Initialization
All initialization options the Flutter SDK exposes — API key, region, debug logging, opt-in/opt-out behaviour.
⚠ TODO — Engineering
Document every public method in the Initialization section. Include the method signature, parameters with types, return type, and a minimal code example. Mark deprecated methods with a callout box.
User identity
Identifying users, anonymous IDs, alias, logout.
⚠ TODO — Engineering
Document every public method in the User identity section. Include the method signature, parameters with types, return type, and a minimal code example. Mark deprecated methods with a callout box.
Events
Tracking custom events with properties; system events captured by default.
⚠ TODO — Engineering
Document every public method in the Events section. Include the method signature, parameters with types, return type, and a minimal code example. Mark deprecated methods with a callout box.
Screen tracking
Automatic vs. manual screen tracking; naming conventions.
⚠ TODO — Engineering
Document every public method in the Screen tracking section. Include the method signature, parameters with types, return type, and a minimal code example. Mark deprecated methods with a callout box.
Push notifications
Registering for pushes; handling rich payloads; deep links.
⚠ TODO — Engineering
Document every public method in the Push notifications section. Include the method signature, parameters with types, return type, and a minimal code example. Mark deprecated methods with a callout box.
In-app messages
Triggering, rendering, and instrumenting in-app campaigns.
⚠ TODO — Engineering
Document every public method in the In-app messages section. Include the method signature, parameters with types, return type, and a minimal code example. Mark deprecated methods with a callout box.
User attributes
Setting profile attributes; supported types; reserved keys.
⚠ TODO — Engineering
Document every public method in the User attributes section. Include the method signature, parameters with types, return type, and a minimal code example. Mark deprecated methods with a callout box.
Consent & privacy
Deferred initialization, opt-out, consent flags, GDPR/DPDP support.
⚠ TODO — Engineering
Document every public method in the Consent & privacy section. Include the method signature, parameters with types, return type, and a minimal code example. Mark deprecated methods with a callout box.