SDK Methods

Below each method you will see a brief description as well as a code example for each of the supported platform/frameworks. If you do not see a command example in a specific language/platform then the command is not available or not relevant for that platform.

`setScreenName`

SDK Version 3.0+: Android iOS React-Native

Set the current Screen Name.

Parameters	Type
ScreenName	String

Returns
Void

NeuroID.setScreenName("myScreenName")

NeuroID.getInstance()?.setScreenName("myScreenName")

await NeuroID.setScreenName("myScreenName")

`enableLogging`

SDK Version 3.1+: Android iOS React-Native

Alters the printing behavior of debug logs (regardless of Prod/Test environment or debug/release SDK build). Default behavior is set to true.

Parameters	Type
enableLogs	Boolean

Returns
Void

Note: Info and error logs will print regardless.

NeuroID.enableLogging(true)
NeuroID.enableLogging(false)

NeuroID.getInstance()?.enableLogging(true)
NeuroID.getInstance()?.enableLogging(false)

await NeuroID.enableLogging(true);
await NeuroID.enableLogging(false);

`attemptedLogin`

SDK Version 3.3.0+: Android iOS React-Native

Mark a login attempt with an optional identifier.

Parameters	Type
attemptedRegisteredUserId	String?

Returns
Void

NeuroID.attemptedLogin("myLoginID")

// Identifier Not Required
NeuroID.attemptedLogin()

NeuroID.getInstance()?.attemptedLogin("myLoginID")

// Identifier Not Required
NeuroID.getInstance()?.attemptedLogin()

await NeuroID.attemptedLogin("myLoginID")

// Identifier Not Required
await NeuroID.attemptedLogin()

`setVariable`

SDK Version 3.3.2+: Android iOS React-Native

Captures a custom variable and value.

Parameters	Type
Key	String
Value	String

Returns
Void

Returns: Void

NeuroID.setVariable("myKey", "myValue")

NeuroID.getInstance()?.setVariable("myKey", "myValue")

await NeuroID.setVariable("myKey", "myValue")

`excludeViewByTestID`

SDK Version 3.0+: Android iOS React-Native

Restrict event capturing on a specific target by ID.

Parameters	Type
ExcludedViewID	String

Returns
Void

Returns: Void

NeuroID.excludeViewByTestID("myExcludedViewTestID")

NeuroID.getInstance()?.excludeViewByTestID("myExcludedViewTestID")

await NeuroID.excludeViewByTestID("myExcludedViewTestID");

`getClientID`

SDK Version 3.0+: Android iOS React-Native

Retrieve the current ClientID.

Returns
String

NeuroID.getClientID()

NeuroID.getInstance()?.getClientID()

await NeuroID.getClientID()

`getEnvironment`

SDK Version 3.0+: Android iOS React-Native

Retrieve the current Environment.

Returns
String

NeuroID.getEnvironment()

NeuroID.getInstance()?.getEnvironment()

await NeuroID.getEnvironment()

`getSDKVersion`

SDK Version 3.0+: Android iOS React-Native

Retrieve the current SDK Version.

Returns
String

NeuroID.getSDKVersion()

NeuroID.getInstance()?.getSDKVersion()

await NeuroID.getSDKVersion()

`getScreenName`

SDK Version 3.0+: Android iOS React-Native

Retrieve the current Screen Name.

Returns
String?

NeuroID.getScreenName()

NeuroID.getInstance()?.getScreenName()

await NeuroID.getScreenName()

`getSessionID`

SDK Version 3.0+: Android iOS React-Native

Retrieve the current SessionID.

Returns
String

NeuroID.getSessionID()

NeuroID.getInstance()?.getSessionID()

await NeuroID.getSessionID()

`getUserID`

SDK Version 3.0+: Android iOS React-Native

Retrieve the current UserID.

Returns
String

NeuroID.getUserID()

NeuroID.getInstance()?.getUserID()

await NeuroID.getUserID()

`getRegisteredUserID`

SDK Version 3.1+: Android iOS React-Native

Retrieve the current RegisteredUserID.

Returns
String

NeuroID.getRegisteredUserID()

NeuroID.getInstance()?.getRegisteredUserID()

await NeuroID.getRegisteredUserID()

`isStopped`

SDK Version 3.0+: Android iOS React-Native

Check if the SDK is stopped/started.

Returns
Boolean

NeuroID.isStopped()

NeuroID.getInstance()?.isStopped()

await NeuroID.isStopped()

`printIntegrationHealthInstruction`

SDK Version 3.0+: Android iOS React-Native

Reprint the Integration Health Report access instructions.

Returns
Void and logs instructions to console.

NeuroID.printIntegrationHealthInstruction()

NeuroID.getInstance()?.printIntegrationHealthInstruction()