Mobile Locker JavaScript SDK
    Preparing search index...

      Mobile Locker JavaScript SDK

      Variables - CRM

      congresses
      contacts
      crm

      Variables - Data

      data
      database
      presentation
      search

      Variables - Device

      device
      permissions
      scanner

      Variables - Networking

      http
      network

      Variables - Storage

      localforage
      storage

      Variables - Analytics

      analytics
      log
      session
      user

      Variables - UI

      share
      ui

      Variables - Other

      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.

      DatabaseErrorCode

      Error codes for SQLite database failures. Extends GeneralErrorCode.

      HTTPErrorCode

      Error codes for HTTP request failures. Extends GeneralErrorCode.

      default
      EMAIL_DELIVERABILITY_STATUSES

      Functions

      isIOS

      Returns true when running inside the Mobile Locker iOS or iPadOS app specifically.

      isElectron

      Returns true when running inside the Mobile Locker Electron desktop app.

      isApp

      Returns true when running inside any Mobile Locker native app — iOS, iPadOS, or Electron.

      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.

      withStatusBooleans

      Wraps a status result object with is{Status} boolean helpers.

      Classes

      MobileLockerError

      Base error class thrown by SDK methods when no domain-specific error applies.

      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.

      Type Aliases

      CRMRefreshMode
      CRMRefreshStatus
      PickerStatus
      PickerResult
      CRMRefreshResult
      AppEnvironment
      HTTPMethod
      HTTPResponseType
      SDKLogLevel
      SDKLogDomain
      NetworkConnectionType
      PermissionStatus
      BiometricType
      DownloadStatus
      DownloadResult
      ScanStatus
      RawScanResult
      ScanResult
      SearchEntityType
      RawVideoResult
      VideoResult
      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.

      DatabaseErrorCode

      Error codes for SQLite database failures. Extends GeneralErrorCode.

      HTTPErrorCode

      Error codes for HTTP request failures. Extends GeneralErrorCode.

      EmailDeliverabilityStatus

      NeverBounce email deliverability result for a contact's email address.

      UserContactDeliverability

      A deliverability status result with is* boolean helpers for each status value.

      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.

      Interfaces

      CRMQueryResult
      DeviceInfo
      HTTPOptions
      HTTPRequestOptions
      HTTPResponse
      MobileLockerLocalForage

      localForage-compatible data API exposed by mobilelocker.localforage.

      SDKLogEntry
      SDKLogFilter
      NetworkStatus
      PermissionResult
      BiometricResult
      SearchOptions
      SearchResults
      ShareRecipient
      StorageEntry
      StorageFilter
      VideoOptions
      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.

      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.

      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.

      UserContact

      A contact from the current user's personal contact list. Mirrors the iOS GRDBUserContact Swift model's toJSON() output.