Objects

The shape of every object the SDK returns or delivers on an event.

NativeCommandResult

What legacy dispatch-style browser commands resolve to. It tells you whether the call reached the app — not the outcome of the native action (that arrives on an event). The common case is triggered: true. Outside the app a command comes back with triggered: false — pending in a browser tab, skipped in a non-DOM environment.

Property	Type	Description
`command`	`string`	The native command that was dispatched.
`queued`	`boolean`	Whether the command was scheduled.
`triggered`	`boolean`	Whether it was handed to the app. Branch on `!triggered` for a web fallback.
`skipped`	`boolean`	Whether it was dropped without triggering.
`pending`	`boolean`	Queued, waiting for the app. A browser tab outside the app resolves here.
`reason`	`string`	Why it was skipped or pending — e.g. `waiting_for_agent`, `not_native`.

Action results

What namespaced helpers such as bdk.media.pickPhotos and bdk.iap.products resolve to. On success ok is true and extra helper-specific fields may be present; on failure it is false with code and message — branch on !result.ok or isBdkError(result). Outside the app, Action-result helpers resolve ok: false with a code like common/feature_disabled or common/timeout (branch on !result.ok); legacy commands resolve triggered: false (branch on !result.triggered).

Property	Type	Description
`ok`	`boolean`	`true` on success, `false` on failure.
`action`	`string`	The helper that ran.
`code`	`string`	Error code when `ok` is `false` — e.g. `common/feature_disabled`.
`message`	`string`	Human-readable error when `ok` is `false`.
`recoverable`	`boolean`	Whether the failure is recoverable. Present when `ok` is `false`.
`details`	`object`	Extra error context, when available.
`requestId`	`string`	Correlation id, when the call supplied or generated one.

BdkDeviceInfo

The device snapshot returned by bdk.ready() and bdk.getDeviceInfo(), and delivered on the deviceInfo event. Most fields are null until the app reports them; biometricsAvailable and smartLoginAvailable are required booleans, and idfa, appTrackingPermissionStatus, and viewType are optional (absent until reported, not null).

Property	Type	Description
`playerId`	`string \| null`	OneSignal player id for push.
`pushToken`	`string \| null`	Device push token.
`deviceModel`	`string \| null`	Device model name.
`deviceOS`	`string \| null`	Operating system.
`deviceOSVersion`	`string \| null`	OS version.
`bdkRelease`	`string \| number \| null`	BDK runtime release.
`deviceLanguage`	`string \| null`	Device language.
`deviceWidth`	`string \| number \| null`	Screen width.
`deviceHeight`	`string \| number \| null`	Screen height.
`versionName`	`string \| null`	Host app version name.
`versionCode`	`string \| number \| null`	Host app version code.
`biometricsAvailable`	`boolean`	Whether biometric login is available.
`smartLoginAvailable`	`boolean`	Whether saved login is available.
`cameraPermissionStatus`	`string \| null`	Camera permission state.
`contactsPermissionStatus`	`string \| null`	Contacts permission state.
`audiorecordPermissionStatus`	`string \| null`	Audio-record permission state.
`externalstoragePermissionStatus`	`string \| null`	Storage permission state.
`locationPermissionStatus`	`string \| null`	Location permission state.
`idfa`	`string` (optional)	iOS advertising id. iOS only.
`appTrackingPermissionStatus`	`string` (optional)	iOS App Tracking Transparency state. iOS only.
`viewType`	`string` (optional)	Host view type, when reported.

BdkCapabilities

Returned by bdk.capabilities.get(), and delivered on the capabilities event. null from get() means the snapshot is unknown — not that every feature is off.

Property	Type	Description
`api`	`number`	API version.
`platform`	`string`	`"ios"` or `"android"`.
`app`	`object`	Host app `versionName` and `versionCode`, when reported.
`features`	`object`	Map of feature id → entry. Ids include `permissions`, `push.prompt`, `push.data`, `att`, `contacts.picker`, `contacts.book`, `badge`, `deeplink.scheme`, `media`, `share.files`, `share.inbound`, `auth.oauth`, `notifications.timesensitive`, `notifications.critical`, `health.read`, `nfc`, `iap`, `ui.datepicker`.
`features[id].enabled`	`boolean`	Whether this build has the feature on.
`features[id].available`	`boolean`	Whether the device can use it. Present when reported.
`features[id].config`	`object`	Feature-specific config, when reported.
`features[id].details`	`object`	Extra feature details, when reported.
`gating`	`object`	`{ schema }` when the app reports a gating schema.

MediaResult

Delivered by photoCaptured, photoSelected, and audioRecorded. Use dataUri to preview inline and fileUrl to upload.

Property	Type	Description
`fileUrl`	`string \| null`	Hosted URL of the file — use to upload.
`dataUri`	`string \| null`	Data URI — use to preview inline.
`contentType`	`string \| null`	The file's MIME type.
`data`	—	The raw file data from the device.

BdkMediaItem

A JPEG from bdk.media.pickPhotos() or bdk.media.takePhoto(). Exactly one of base64 or fileUrl is set; the other is null.

Property	Type	Description
`kind`	`string`	`"image"`.
`mimeType`	`string`	`"image/jpeg"`.
`base64`	`string \| null`	JPEG bytes as base64.
`fileUrl`	`string \| null`	Hosted file URL.
`width`	`number`	Pixel width.
`height`	`number`	Pixel height.
`sizeBytes`	`number`	File size in bytes.
`name`	`string`	File name.

BiometricResult

Delivered on the biometricResult event after bdk.auth.authenticateBiometrics().

Property	Type	Description
`status`	`string`	`"success"` or `"failed"`.
`platform`	`string`	`"ios"` or `"android"`.
`data`	—	The raw native auth result.

SmartLoginCredentials

Delivered on the smartLoginCredentials event. If either field is null, nothing usable is saved — fall back to your login screen.

Property	Type	Description
`email`	`string \| null`	The saved email.
`password`	`string \| null`	The saved password.

DeviceVariableResult

Delivered on the deviceVariable event after reading a cached value.

Property	Type	Description
`name`	`string`	The variable name.
`data`	—	The stored value, or `null` if the key was never stored.

UrlParam

A query parameter you pass to bdk.navigation.openLink({ urlParams }).

Property	Type	Description
`key`	`string`	The parameter name.
`value`	`string \| number \| boolean`	The parameter value.

BdkError

Thrown by a rejected command and passed to the onError config callback and the error event.

Property	Type	Description
`code`	`string`	One of `BDK_NOT_NATIVE`, `BDK_NATIVE_UNAVAILABLE`, `BDK_UNSUPPORTED_VERSION`, `BDK_UNSUPPORTED_PLATFORM`, `BDK_LISTENER_ERROR`, `BDK_PROVIDER_ERROR`, `BDK_VALIDATION_ERROR`.
`message`	`string`	A human-readable description.
`details`	`object`	Extra context about the error, when available.

BdkContact

A contact from bdk.contacts.pick() or bdk.contacts.list().

Property	Type	Description
`name`	`string`	Display name.
`givenName`	`string`	Given name.
`familyName`	`string`	Family name.
`phones`	`array`	`{ type, label, number }`.
`emails`	`array`	`{ type, label, address }`.

Permission entry

One value in the permissions map from bdk.permissions.status() and the permissions.changed event.

Property	Type	Description
`status`	`string`	`"granted"`, `"denied"`, `"notDetermined"`, `"limited"`, `"provisional"`, `"restricted"`, or `"unsupported"`.
`canPrompt`	`boolean`	Whether the OS will still show a prompt.
`detail`	`object`	Optional `{ precision, scope, degraded }`.

BdkDeepLinkRecord

Delivered on deeplink.received. URL form (form: "url") already navigated; path form (form: "path") is for in-page routing.

Property	Type	Description
`form`	`string`	`"url"` or `"path"`.
`rawUrl`	`string`	The raw incoming URI.
`source`	`string`	`"scheme"`.
`coldStart`	`boolean`	Whether the app was launched by this link.
`id`	`string`	Record id — events and replay are deduped by this.
`ts`	—	When the link was received.
`targetUrl`	`string`	URL-form destination.
`path`	`string`	Path-form path.
`query`	`object`	Path-form query.

BdkIapProduct

A store product from bdk.iap.products().

Property	Type	Description
`id`	`string`	Product id.
`kind`	`string`	`"consumable"`, `"nonConsumable"`, `"subscription"`, or `"nonRenewingSubscription"`.
`title`	`string`	Store title.
`description`	`string`	Store description.
`price`	`object`	`{ amount, currency, formatted }`.
`subscription`	`object`	Present on subscriptions: `{ groupId, period, plans }`.
`subscription.plans`	`array`	Each plan has `planId`, `offerId`, and `phases`.
`subscription.plans[].phases`	`array`	`{ type, price, period, cycles }`. `type` is `"trial"`, `"intro"`, or `"base"`.
`raw`	`Record<string, unknown>` (optional)	Raw store payload.

BdkIapEntitlement

A current entitlement from bdk.iap.entitlements() or bdk.iap.restore().

Property	Type	Description
`productId`	`string`	Product id.
`kind`	`string`	Product kind.
`state`	`string`	`"active"`, `"gracePeriod"`, `"billingRetry"`, `"revoked"`, or `"expired"`.
`expiresAt`	`string \| null`	Expiry, when the store reports one.
`willRenew`	`boolean`	Whether the subscription will renew.
`planId`	`string \| null`	Current plan id, when present.
`latestTransactionId`	`string`	Latest transaction id, when present.
`purchaseToken`	`string \| null`	Store purchase token, when present.
`acknowledged`	`boolean`	Whether the purchase is acknowledged.

IAP purchase completed

Delivered on iap.purchaseCompleted. pending is not a final grant — keep listening.

Property	Type	Description
`platform`	`string`	`"ios"` or `"android"`.
`requestId`	`string \| null`	Correlation id.
`ok`	`boolean`	Whether the purchase succeeded.
`state`	`string`	`"purchased"`, `"pending"`, `"cancelled"`, or `"failed"`.
`code`	`string \| null`	Error code when the purchase failed.
`transaction`	`object`	Store transaction, when present.

BdkInboundShare

Inbound content from the OS share sheet, on share.received and from bdk.share.getPending(). File bytes and local paths are never included.

Property	Type	Description
`shareId`	`string`	Share id.
`receivedAt`	—	When the share arrived.
`source`	`string`	`"ios-extension"` or `"android-intent"`.
`status`	`string`	`"pending"`, `"complete"`, `"partial"`, or `"failed"`.
`items`	`array`	Text, URL, or file items. File items have `kind` (`image`, `video`, or `file`), `name`, `mime`, `sizeBytes`, and `upload`.
`items[].upload.status`	`string`	`"pending"`, `"uploading"`, `"uploaded"`, `"failed"`, `"rejected"`, or `"skipped"`.
`items[].upload.httpStatus`	—	HTTP status, when present.
`items[].upload.response`	—	Upload response, when present.
`items[].upload.error`	—	Upload error, when present.

BdkShareItem

One item passed to bdk.share.send(). Mix types freely in a single call.

Property	Type	Description
`type`	`string`	`"text"`, `"url"`, `"file"`, `"image"`, `"video"`, or `"audio"`.
`text`	`string`	The text to share. Text items only.
`url`	`string`	The link, or the remote file to fetch and share.
`filename`	`string`	Optional name for the shared file.

BdkPushDataMessage

One retained background data message from bdk.push.getDataMessages(); live arrivals carry the same fields on push.dataReceived.

Property	Type	Description
`id`	`string`	Message id.
`receivedAt`	`number`	When the device received it.
`appState`	`string`	`"foreground"`, `"background"`, or `"cold"`.
`data`	`object`	The message's data payload.
`delivered`	`boolean` (optional)	Whether delivery to a page was attempted.

Health results

Returned by bdk.health.status() and bdk.health.aggregate(). Type ids are steps, distance, activeCalories, heartRate, restingHeartRate, weight, height, bloodOxygen, sleep, and workouts.

Status from bdk.health.status():

Property	Type	Description
`available`	`boolean`	Whether health data is available on this device.
`platform`	`string`	`"ios"` or `"android"`.
`types`	`object`	Map of type id → `{ status, requested }`.
`types[id].status`	`string`	`"granted"`, `"notGranted"`, or `"unknown"`.
`types[id].requested`	—	Whether this type has been requested.
`reason`	`string`	Why health is unavailable, when present: `device_unsupported`, `provider_missing`, or `provider_update_required`.

Aggregate from bdk.health.aggregate():

Property	Type	Description
`type`	`string`	The health data type id the buckets belong to.
`unit`	`string`	Aggregate unit.
`stat`	`string`	`"sum"` or `"avg"`.
`interval`	`string`	`"total"`, `"hour"`, `"day"`, or `"month"`.
`buckets`	`array`	Aggregated buckets. Use these instead of summing raw samples.

NFC tag

Returned by bdk.nfc.read() and bdk.nfc.getLaunchTag(), and as tag on nfc.launchTag. id is null on iOS and a lowercase hex string on Android.

Property	Type	Description
`id`	`string \| null`	Tag id.
`ndef`	`object`	NDEF message: `writable`, `capacityBytes`, `records`.
`ndef.records`	`array`	NDEF records.

Event payloads

A few events deliver raw native data rather than a fixed object. Here's what each one contains.

Event	Delivers
`contacts`	The device address book — an array of contacts, each with a name, phone number(s), and email(s).
`location`	A `"latitude,longitude"` string, or an object with optional `latitude`, `longitude`, and `data`.
`barcodeScanned`	The scanned code — its `type` (e.g. `qr`) and decoded `content`.
`screenshot`	The captured image, as a data URI (`string`).
`menuClicked`	The menu item the user tapped.
`popupClosed`	Which button dismissed the popup.
`datePicked`	The date/time the user selected.
`purchaseSuccess` / `purchaseFailed` / `receiptReceived`	`{ platform, data }` — the store's raw purchase details; verify server-side.
`permissions.changed`	`{ changed, previous, permissions }` — `permissions` is a map of permission entries. Fires when a tracked permission changes, not on the first snapshot.
`att.changed`	`{ status, idfa }` — `status` is `granted`, `denied`, `restricted`, or `notDetermined`.
`auth.completed`	`{ mode, provider, handoff }`.
`auth.cancelled`	`{ mode, provider, reason }` — `mode` is `auto` or `explicit`; `reason` is `dismissed`, `provider_denied`, or `timeout`.
`push.dataReceived`	`{ id, receivedAt, appState, data }` — `appState` is `foreground`, `background`, or `cold`.
`share.uploadProgress`	`{ shareId, itemIndex, bytesSent, totalBytes, progress }`.
`nfc.launchTag`	`{ url, tag }` — `tag` is an NFC tag.
`iap.transactionUpdated`	`{ reason, transaction }` — `reason` is `renewal`, `revoked`, or `external`.