Skip to content

Public API reference

All public wrappers follow the same semantic contract even when method names and async models differ.

OperationAndroidiOSNode/Electron.NETC ABI
Create with consentBuilder.createcreateWithConsentElectron helper / constructor with receiptWPF helper / options with receiptConsent-aware constructor
Startconnect()connect()connect()Connect()sdk_connect
Online stateisOnline()isOnlineisOnline()IsOnlinesdk_is_online
Pausedisconnect()disconnect()disconnect()Disconnect()sdk_disconnect
RevokerevokeConsentrevokeConsentinstance/static helperRevokeAsyncHost consent implementation
Final releaseclose()close()free()Dispose()sdk_free

Protected UI wrappers create a native handle only after an accepted, verified decision. Node and non-WPF desktop hosts require an approved receipt source. Legacy boolean-only creation paths are not authorization.

Every connect spelling starts the supervisor. It does not wait for online. Use the connected callback/event or online-state API.

  • Android: main Handler by default or caller-provided Executor.
  • Kotlin: configured callback dispatcher and lifecycle flow.
  • iOS: configured DispatchQueue.
  • Node/Electron: JavaScript event loop via native-state polling.
  • .NET: managed callbacks/events with exception containment.
  • C: SDK runtime thread; application must marshal.

Wrappers expose optional device identity seed/path configuration. Default platform persistence is preferred. Changing identity can invalidate a stored consent decision.

Final release clears callbacks and frees native state. The application must drop its reference and make no further SDK call. A successful active-instance revoke is also terminal.

For exact code, use the platform guide. For native symbols and error accessors, see Native C ABI.