Android SDK Reference

Class CredoAppService.Builder

CredoAppService.Builder is responsible for creating the CredoAppService class instance

CredoAppService.Builder(context: Context)

Parameters:

Method CredoAppService.Builder.addModule(module: IModule)

addModule(module: IModule) : CredoAppService.Builder

• The method adds a module to the builder configuration.

Parameters

Returns

CredoAppService.Builder

Method CredoAppService.Builder.addPlugin(plugin: IPlugin<*>)

addPlugin(plugin: IPlugin<*>) : CredoAppService.Builder

• The method adds a plugin to the builder configuration.

Parameters

Returns

CredoAppService.Builder

Method CredoAppService.Builder.setIgnorePermissions(value)

 setIgnorePermissions(value: Boolean) : CredoAppService.Builder

• The method sets if SDK should prevent the run of CredoAppService.collect() or execute() 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

Parameters

Returns

CredoAppService.Builder

Method CredoAppService.Builder.build()

build() : CredoAppService

Returns

configured CredoAppService instance.

Class CredoAppService

CredoAppService is responsible for capturing a client's digital footprint

Method CredoAppService.collect()

collect() : CredoAppResult<String>

• Collects dataset and returns it locally. This method must not be called on the UI thread.
• Does not accept any parameters

Returns

Method CredoAppService.getUngrantedPermissions()

getUngrantedPermissions(): CredoAppResult<Array<String>>

Returns

Class CredoAppResult<T>.Success

CredoAppResult.Success states for successful operation

Fields:

ClassCredoAppResult.Error

CredoAppResult.Error states for operation fail and contains error details

Fields:

Class BehavioralModule

BehavioralModule()

BehavioralModule is responsible for capturing a client's behavioral interaction with UI and OS

Static method BehavioralModule.startTracking()

startTracking()

• Starts behavioral interaction metadata tracking

📘

When to invoke startTracking() ?

Before version 3.0.0 <= should be called as early as possible for instance, in desired activity onCreate() method. If you've version >= 3.0.0 you can invoke startTracking() in any place in your code.

Static method BehavioralModule.stopTracking()

stopTracking()

• Terminates behavioral metadata tracking

Static method BehavioralModule.setLogger(plugin: IPlugin<ILogger>)

setLogger(plugin: IPlugin<ILogger>)

• Sets the LoggingPlugin into BehavioralModule

How to use BehavioralModule

class MainActivity : AppCompatActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main) 
        val loggingPlugin = LoggingPlugin()
        
        BehavioralModule()
        BehavioralModule.setLogger(loggingPlugin)
        BehavioralModule.startTracking()
    }

    override fun onStop() {
        // calling stopTracking() method is optional
        BehavioralModule.stopTracking()
    }
}

public class MainActivity extends AppCompatActivity {
  @Override
   protected void onCreate(Bundle savedInstanceState) {
      super.onCreate(savedInstanceState);
      setContentView(R.layout.activity_main);
      new BehaviouralModule();
      BehaviouralModule.setLogger(new LoggingPlugin());
      BehaviouralModule.startTracking();
   }
  
  @Override
  protected void onStop() {
      // calling stopTracking() method is optional
      BehaviouralModule.stopTracking();
  }
}

Error Codes