Skip to content

API overview

Variable Description
analytics -
log -
session -
user -
Variable Description
congresses -
contacts -
crm -
Variable Description
data -
database -
presentation -
search -
Variable Description
device -
permissions -
scanner -
Variable Description
http -
network -
Name Description
CRMRefreshMode -
CRMRefreshStatus -
PickerStatus -
PickerResult -
CRMRefreshResult -
CRMQueryResult -
AppEnvironment -
DeviceInfo -
HTTPMethod -
HTTPResponseType -
HTTPOptions -
HTTPRequestOptions -
HTTPResponse -
MobileLockerLocalForage localForage-compatible data API exposed by mobilelocker.localforage.
SDKLogLevel -
SDKLogDomain -
SDKLogEntry -
SDKLogFilter -
NetworkConnectionType -
NetworkStatus -
PermissionStatus -
BiometricType -
PermissionResult -
BiometricResult -
DownloadStatus -
DownloadResult -
ScanStatus -
RawScanResult -
ScanResult -
SearchEntityType -
SearchOptions -
SearchResults -
ShareRecipient -
StorageEntry -
StorageFilter -
VideoOptions -
RawVideoResult -
VideoResult -
isIOS Returns true when running inside the Mobile Locker iOS or iPadOS app specifically.
isAndroid Returns true when running inside the Mobile Locker Android app.
isElectron Returns true when running inside the Mobile Locker Electron desktop app.
isWindows Returns true when running inside the Mobile Locker Windows app.
isApp Returns true when running inside any Mobile Locker native app — iOS, iPadOS, Android, or Windows.
isCDN Returns true when the presentation is served from a Mobile Locker CDN hostname (e.g. app.mobilelocker.com, *.app.mobilelocker.com, *.eu.mobilelocker.com).
isMobileLocker Returns true when running in any Mobile Locker environment — either a native app or a CDN-hosted presentation.
GeneralErrorCode Error codes shared across all SDK domains. Use these as named constants rather than raw strings.
GeneralErrorCode Error codes shared across all SDK domains. Use these as named constants rather than raw strings.
CRMErrorCode Error codes for CRM-specific failures. Extends GeneralErrorCode.
CRMErrorCode Error codes for CRM-specific failures. Extends GeneralErrorCode.
DatabaseErrorCode Error codes for SQLite database failures. Extends GeneralErrorCode.
DatabaseErrorCode Error codes for SQLite database failures. Extends GeneralErrorCode.
HTTPErrorCode Error codes for HTTP request failures. Extends GeneralErrorCode.
HTTPErrorCode Error codes for HTTP request failures. Extends GeneralErrorCode.
MobileLockerError Base error class thrown by SDK methods.
MobileLockerCRMError Thrown by mobilelocker.crm.* methods on CRM-specific failures.
MobileLockerDatabaseError Thrown by mobilelocker.database.* methods on SQLite failures.
MobileLockerHTTPError Thrown by mobilelocker.http.* methods on network-level failures (timeout, no connection).
MobileLockerHttpResponseError Thrown by mobilelocker.http.* methods when the server returns a non-2xx HTTP status.
mapToMobileLockerError Map an unknown failure into MobileLockerError. Re-throws existing MobileLockerError instances unchanged.
mapToCRMError Map an unknown failure into MobileLockerCRMError.
mapToDatabaseError Map an unknown failure into MobileLockerDatabaseError.
unsupportedEnvironmentError Error for methods that only work in a specific host environment.
invalidArgumentError Error for invalid caller-supplied arguments.
default -
Attendee An event attendee captured via badge scan or lead retrieval. Mirrors the iOS GRDBAttendee Swift model’s toJSON() output.
Brand A brand associated with a team’s presentations. Mirrors the iOS GRDBBrand Swift model’s toJSON() output.
BusinessCard A business card captured via camera scan. Mirrors the iOS GRDBBusinessCard Swift model.
CRMAccount CRM account record from the connected CRM. Mirrors the iOS GRDBAccount.toJSON() output.
CRMAddress CRM address record from the connected CRM. Mirrors the iOS GRDBAddress.toJSON() output.
CRMContact CRM contact record from the connected CRM. Mirrors the iOS GRDBContact.toJSON() output.
CRMLead CRM lead record from the connected CRM. Mirrors the iOS GRDBLead.toJSON() output.
CRMUser CRM user record for the connected team. Mirrors the iOS GRDBCRMUser.toJSON() output.
Customer A CRM customer record associated with the current presentation session. Mirrors the iOS GRDBCustomer Swift model.
DatabaseQueryResult The result of a mobilelocker.database.query() call.
DatabaseColumnInfo Metadata for a single column returned by mobilelocker.database.describe().
DatabaseTableDescription Schema description of a SQLite table, returned by mobilelocker.database.describe().
Event A lead retrieval event (congress, conference, or trade show). Mirrors the iOS GRDBEvent Swift model’s toJSON() output.
Folder A presentation folder in the user’s library. Mirrors the iOS GRDBFolder Swift model’s toJSON() output.
Label A label that can be applied to presentations for categorisation. Mirrors the iOS GRDBLabel Swift model’s toJSON() output.
PageCursor Cursor-paginated list page from the Mobile Locker JS bridge (iOS 5.5.0+).
PageMeta -
Page -
Presentation A presentation in the user’s Mobile Locker library. Mirrors the iOS GRDBPresentation Swift model’s toJSON(files:) output.
PresentationFile A file asset belonging to a presentation. Mirrors the iOS GRDBPresentationFile Swift model’s toJSON() output.
Product A product record available to the current team. Mirrors the iOS GRDBProduct Swift model’s toJSON() output.
User The authenticated Mobile Locker user. Mirrors the iOS GRDBUser Swift model’s toJSON() output.
EmailDeliverabilityStatus NeverBounce email deliverability result for a contact’s email address.
UserContactDeliverability A deliverability status result with is* boolean helpers for each status value.
EMAIL_DELIVERABILITY_STATUSES -
UserContact A contact from the current user’s personal contact list. Mirrors the iOS GRDBUserContact Swift model’s toJSON() output.
SnakeToCamel -
WithStatusBooleans Intersects a type that has a status string field with boolean helpers of the form is{Status} for every status value in the union.
withStatusBooleans Wraps a status result object with is{Status} boolean helpers.
Variable Description
localforage -
storage -
Variable Description
share -
ui -