Cordova SDK Reference

Class CredoAppService

Represents the bridge between Cordova and native SDK

new 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(false)

Parameters:

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

The default value is true.
bool

πŸ“˜

IosMusicModule

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

Method setIgnorePermissions()

This method is designed to manage permission behavior on Android.

  • The method sets if SDK should prevent the run of collectAsync() 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
valueThe true value allows data collection even if not all permissions are not granted. The false value restricts data collection until all permissions (including normal permissions) are granted.

The default value is true.
bool

Method addModuleAsync()

The method adds a module to the CredoAppService configuration.

await service.addModuleAsync(new SampleModule())

Parameters:

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

Returns:

TypeDescription
PromiseReturns Promise object

Method collectAsync()

Collects data from the phone and returns locally.

await collectAsync()

Returns:

TypeDescription
Promise<String>Returns JSON dataset in compressed string format if collect action is succeeded or error with code and message

Error Codes

Status CodeReasonDescription
30Duplicated areas errorThe extracting areas are duplicated.
90Unknown errorAn unexpected error occurred.