These docs are for v2.6. Click to read the latest docs for v3.1.

Flutter SDK Reference

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: 

NameDescriptionType
forceIf true then SDK requests permissions automatically otherwise SDK omits requesting permissions.

The default value is true.
bool

📘

Note

Even when the value is set to false, the Music permission (NSAppleMusicUsageDescription in IosMusicModule module) will be automatically requested by the SDK when related data will be involved.

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: 

NameDescriptionType
ignorePermissionsThe true value allows data collection even if not all permissions are granted. The false value restricts data collection until all permissions (including normal permissions) are granted.

The default value is true.
bool

Method addModule()

The method adds a module to the CredoAppService configuration.

await service.addModule(SampleModule());

Parameters:

NameDescriptionType
moduleRepresents platform moduleAndroidApplicationModule
AndroidCalendarModule
AndroidContactModule
AndroidAccountModule
AndroidImagesModule
AndroidIovationModule
AndroidAudioModule
AndroidVideoModule
AndroidSmsModule
IosMusicModule
IosCalendarEventsModule
IosCalendarRemindersModule
IosContactsModule
IosIovationModule
IosMediaModule

Returns:

TypeDescription
FutureReturns Future

Method collect()

📘

Collects data from the phone and returns locally.

await service.collect();

Returns:

TypeDescription
FutureReturns JSON dataset in compressed string format if collect action is succeeded

Class CredoappResult

CredoAppResult states for successful operation and contains a value

Field NameTypeDescription
valueStringReturns collected data
isFailureboolReturns false if the operation is completed successfully otherwise true.
messageStringReturns message value if the operation is failed.
codeStringReturns code value if the operation is failed.

Error Codes

Status CodeReasonDescription
30Duplicated areas errorThe extracting areas are duplicated.
90Unknown errorUnexpected error occurred.
91The module is not supportedUse a higher plugin version.