Core

Class CredoAppService

Represents the bridge between Flutter and native SDK.

var service = CredoAppService();

Method setForceResolvePermissions()

This method is designed to manage permission behavior on iOS.

If it is determined to be true, the SDK will automatically request permissions; otherwise, the SDK will not request permissions.

service.setForceResolvePermissions(bool force)

Parameters: 

Method setIgnorePermissions()

This method is designed to manage permission behavior on Android.

• The method sets if SDK should prevent the run of collect() if permissions aren't granted.
• The true value allows collecting dataset even if not all permissions are granted.
• The false value restricts collecting dataset from running until all permissions are granted (including normal permissions).
• The default value is true

service.setIgnorePermissions(false)

Parameters: 

Method addModule()

The method adds a module to the CredoAppService configuration.

await service.addModule(SampleModule());

Parameters:

Returns:

Method collect()

await service.collect();

Returns:

Class CredoappResult

CredoAppResult states for successful operation and contains a value

Error Codes

Behavioral

Class CredoAppBehavioral

CredoAppBehavioral widget is responsible for capturing a user's interaction with UI and OS for both Android and iOS platforms. The app root element has to be wrapped with CredoAppBehavioral widget to track all widgets that exist on the screen.

Constructor

How to use CredoAppBehavioral

import 'package:flutter_behavioral/behavioral/credoapp_behavioral.dart';

void main() {
  runApp(CredoAppBehavioral(
      key: Key("root_layout"),
      startTracking: true,
      child: const MyApp()));
}

Class BehavioralModule

BehavioralModule is responsible for collecting behavioral events

BehavioralModule()

Static method BehavioralModule.startTracking()

Starts behavioral interaction metadata tracking

BehavioralModule.startTracking()

Static method BehavioralModule.stopTracking()

Terminates behavioral metadata tracking

BehavioralModule.stopTracking()

How to use start and stop tracking methods

If the false value has been passed for the startTracking parameter in CredoAppBehavioral widget, the tracking process must be initiated manually. To start tracking, the BehavioralModule.startTracking() method needs to be called. The example is below

import 'package:flutter_behavioral/module.dart'; 

ElevatedButton(onPressed: () => { BehavioralModule.startTracking()},
                    key: Key("go_to_loan_form_screen_btn"),
                    child: Text("Open Loan form screen"))

To stop the tracking process the BehavioralModule.stopTracking() method has to be called. The example is below

import 'package:flutter_behavioral/module.dart';

ElevatedButton(onPressed: () => { BehavioralModule.stopTracking()},
                    key: Key("submit_btn"),
                    child: Text("Submit"))

Static method BehavioralModule.addPlugin(dynamic plugin)

BehavioralModule.addPlugin(dynamic plugin)

Attaches behavioral plugin to BehavioralModule instance

How to use addPlugin method

Make sure you add Phone Behavioral plugin after android.permission.READ_PHONE_STATE successful permission request or call the method on the app startup if permission is already granted.

if(Platform.isAndroid){
  BehavioralModule.addPlugin(AndroidPhoneBehavioralPlugin());
  BehavioralModule.addPlugin(AndroidGuardBehavioralPlugin());
}

Class CredoAppNavigatorObserver

CredoAppNavigatorObserver connects the Behavioral module to Flutter's navigation system and provides the Screen Name used to associate collected behavioral events with the screen where they occur. This allows events from different screens to be distinguished and analyzed separately.

Screen context is particularly important when multiple screens contain similar UI elements or interactions. For example, taps on a Continue button during registration can be distinguished from taps on a Continue button on a payment screen.

Use it alongside CredoAppBehavioral: the wrapper captures user interactions with the UI, while the observer provides the navigation integration.

create()

Obtain the SDK navigator observer using:

final observer = CredoAppNavigatorObserver.create();

Pass the returned observer to your navigator's observer configuration. The registration point depends on how navigation is implemented in your application.

How to use CredoAppNavigatorObserver

For applications using MaterialApp, add the observer to navigatorObservers:

MaterialApp(
  navigatorObservers: [
    CredoAppNavigatorObserver.create(),
  ],
  home: const MyHomePage(title: 'Home Page'),
)

Other navigation configurations

MaterialApp.router does not accept navigatorObservers. You do not need to change your application's navigation architecture to use the observer.

Navigation scope

Flutter delivers observer notifications for the Navigator to which the observer is attached. Registration on the root navigator does not automatically subscribe an observer to separate nested navigators.

Changes within an existing route, such as switching PageView pages without a navigation operation, are not navigator route changes.

For the complete application setup, see Flutter SDK Integration.

Widget identification