Variable defaultConst

Type Declaration

• analytics: {
      logEvent(
          category: string,
          action: string,
          uri: string,
          data?: unknown,
          method?: string,
      ): void;
  }

  • logEvent: function

    • logEvent(
          category: string,
          action: string,
          uri: string,
          data?: unknown,
          method?: string,
      ): void

      Track a custom analytics event.

      Parameters

      • category: string

        Event category (e.g. 'data-capture', 'share').

      • action: string

        Event action (e.g. 'submit', 'open').

      • uri: string

        The URI or name that identifies the subject of the event.

      • Optionaldata: unknown

        Optional payload attached to the event.

      • method: string = DEFAULT_METHOD

        Internal tracking method; defaults to 'trackevent'.

      Returns void

      Example

      mobilelocker.analytics.logEvent('product', 'view', '/slides/overview', { productId: 42 })
      Copy

• congresses: {
      get(eventID: number): Promise<Event>;
      getAttendees(eventID: number): Promise<Attendee[]>;
      getBusinessCards(): Promise<BusinessCard[]>;
      list(): Promise<Event[]>;
  }

  • get: function

    • get(eventID: number): Promise<Event>

      Get a single lead retrieval event by ID.

      Parameters

      • eventID: number

        The numeric ID of the event.

      Returns Promise<Event>

      The matching Event.

      Throws

      MobileLockerError on network failure or if the event is not found.

  • getAttendees: function

    • getAttendees(eventID: number): Promise<Attendee[]>

      Get all attendees for a lead retrieval event.

      Parameters

      • eventID: number

        The numeric ID of the event.

      Returns Promise<Attendee[]>

      Array of Attendee objects.

      Throws

      MobileLockerError on network failure or server error.

  • getBusinessCards: function

    • getBusinessCards(): Promise<BusinessCard[]>

      Get all business cards scanned by the current user.

      Returns Promise<BusinessCard[]>

      Array of BusinessCard objects.

      Throws

      MobileLockerError on network failure or server error.

  • list: function

    • list(): Promise<Event[]>

      List all lead retrieval events available to the current user.

      Returns Promise<Event[]>

      Array of Event objects.

      Throws

      MobileLockerError on network failure or server error.

• contacts: {
      getAll(): Promise<UserContact[]>;
      getChunked(minID: number, limit: number): Promise<UserContact[]>;
  }

  • getAll: function

    • getAll(): Promise<UserContact[]>

      Get all contacts for the current user.

      Returns Promise<UserContact[]>

      Array of UserContact objects.

      Throws

      MobileLockerError on network failure or server error.

  • getChunked: function

    • getChunked(minID: number, limit: number): Promise<UserContact[]>

      Get a paginated chunk of contacts starting after a given ID.

      Useful for incrementally syncing large contact lists without loading everything into memory at once.

      Parameters

      • minID: number

        Return only contacts with an ID greater than this value.

      • limit: number

        Maximum number of contacts to return.

      Returns Promise<UserContact[]>

      Array of UserContact objects.

      Throws

      MobileLockerError on network failure or server error.

• crm: {
      addCurrentCustomer(customerID: string): Promise<void>;
      clearCurrentCustomers(): Promise<void>;
      getAccounts(): Promise<unknown>;
      getAddresses(): Promise<unknown>;
      getContacts(): Promise<unknown>;
      getCurrentCustomers(): Promise<Customer[]>;
      getRecentCustomers(): Promise<Customer[]>;
      getUsers(): Promise<unknown>;
      isCurrentCustomer(objectID: string): Promise<boolean>;
      openCustomerPicker(): Promise<
          { customers?: Customer[]; status: PickerStatus },
      >;
      query(
          soql: string,
          parameters?: Record<string, unknown>,
      ): Promise<CRMQueryResult>;
      refresh(
          options?: { mode?: CRMRefreshMode },
      ): Promise<{ status: CRMRefreshStatus }>;
      removeCurrentCustomer(customerID: string): Promise<void>;
      setCurrentCustomers(customerIDs: string[]): Promise<void>;
  }

  • addCurrentCustomer: function

    • addCurrentCustomer(customerID: string): Promise<void>

      Add a single customer to the current session without replacing existing ones.

      Parameters

      • customerID: string

        The CRM object ID of the customer to add.

      Returns Promise<void>

      Throws

      MobileLockerCRMError on network failure or server error.

  • clearCurrentCustomers: function

    • clearCurrentCustomers(): Promise<void>

      Remove all customers from the current session.

      Returns Promise<void>

      Throws

      MobileLockerCRMError on network failure or server error.

  • getAccounts: function

    • getAccounts(): Promise<unknown>

      Get all CRM accounts synced for the current user.

      Returns Promise<unknown>

      Raw account records from the connected CRM.

      Throws

      MobileLockerCRMError on network failure, auth expiry, or server error.

  • getAddresses: function

    • getAddresses(): Promise<unknown>

      Get all CRM addresses synced for the current user.

      Returns Promise<unknown>

      Raw address records from the connected CRM.

      Throws

      MobileLockerCRMError on network failure, auth expiry, or server error.

  • getContacts: function

    • getContacts(): Promise<unknown>

      Get all CRM contacts synced for the current user.

      Returns Promise<unknown>

      Raw contact records from the connected CRM.

      Throws

      MobileLockerCRMError on network failure, auth expiry, or server error.

  • getCurrentCustomers: function

    • getCurrentCustomers(): Promise<Customer[]>

      Get the customers currently associated with the active presentation session.

      Returns Promise<Customer[]>

      Array of Customer objects.

      Throws

      MobileLockerCRMError on network failure or server error.

  • getRecentCustomers: function

    • getRecentCustomers(): Promise<Customer[]>

      Get the customers most recently viewed by the current user.

      Returns Promise<Customer[]>

      Array of Customer objects, newest first.

      Throws

      MobileLockerCRMError on network failure or server error.

  • getUsers: function

    • getUsers(): Promise<unknown>

      Get all CRM users synced for the current team.

      Returns Promise<unknown>

      Raw user records from the connected CRM.

      Throws

      MobileLockerCRMError on network failure, auth expiry, or server error.

  • isCurrentCustomer: function

    • isCurrentCustomer(objectID: string): Promise<boolean>

      Check whether a CRM object is currently associated with the active session.

      Parameters

      • objectID: string

        The CRM object ID to check (e.g. a Salesforce Account ID).

      Returns Promise<boolean>

      true if the customer is current, false otherwise.

      Throws

      MobileLockerCRMError on network failure or server error.

  • openCustomerPicker: function

    • openCustomerPicker(): Promise<{ customers?: Customer[]; status: PickerStatus }>

      Open the native customer picker UI and let the user select one or more customers.

      Returns Promise<{ customers?: Customer[]; status: PickerStatus }>

      An object with status ('selected' or 'cancelled') and an optional customers array.

      Remarks

      iOS app only. Throws in all other environments.

      Throws

      MobileLockerError if called outside the iOS app.

      Throws

      MobileLockerCRMError on network failure or server error.

      Example

      const { status, customers } = await mobilelocker.crm.openCustomerPicker()
      if (status === 'selected') console.log(customers)
      Copy

  • query: function

    • query(
          soql: string,
          parameters?: Record<string, unknown>,
      ): Promise<CRMQueryResult>

      Execute a SOQL query against the connected CRM.

      Parameters

      • soql: string

        A valid SOQL SELECT statement.

      • Optionalparameters: Record<string, unknown>

        Optional named bind parameters referenced in the SOQL string.

      Returns Promise<CRMQueryResult>

      A CRMQueryResult containing rows, totalSize, and done.

      Throws

      MobileLockerCRMError with code SOQLInvalid on a syntax error, or on network/auth failure.

      Example

      const result = await mobilelocker.crm.query('SELECT Id, Name FROM Account WHERE Name = :name', { name: 'Acme' })
      Copy

  • refresh: function

    • refresh(
          options?: { mode?: CRMRefreshMode },
      ): Promise<{ status: CRMRefreshStatus }>

      Trigger a CRM data refresh for the current user.

      Parameters

      • Optionaloptions: { mode?: CRMRefreshMode }

        • Optionalmode?: CRMRefreshMode

          'incremental' (default) syncs only new/changed records; 'full' re-syncs everything.

      Returns Promise<{ status: CRMRefreshStatus }>

      An object with status: 'started' if the refresh was queued, 'not_connected' if the CRM is unreachable.

      Throws

      MobileLockerCRMError on auth expiry or server error.

      Example

      const { status } = await mobilelocker.crm.refresh({ mode: 'full' })
      Copy

  • removeCurrentCustomer: function

    • removeCurrentCustomer(customerID: string): Promise<void>

      Remove a single customer from the current session.

      Parameters

      • customerID: string

        The CRM object ID of the customer to remove.

      Returns Promise<void>

      Throws

      MobileLockerCRMError on network failure or server error.

  • setCurrentCustomers: function

    • setCurrentCustomers(customerIDs: string[]): Promise<void>

      Replace the current customers for the active session.

      Parameters

      • customerIDs: string[]

        Array of CRM object IDs to set as current.

      Returns Promise<void>

      Throws

      MobileLockerCRMError on network failure or server error.

• data: { submitForm(formName: string, formInput: Record<string, unknown>): void }

  • submitForm: function

    • submitForm(formName: string, formInput: Record<string, unknown>): void

      Submit a data capture form event.

      Records the form submission in the Mobile Locker analytics pipeline under the 'data-capture' category. Use this to track lead forms, survey responses, or any structured input the user submits during a presentation.

      Parameters

      • formName: string

        Identifier for the form (e.g. 'lead-form', 'product-interest').

      • formInput: Record<string, unknown>

        Key/value pairs representing the form fields and their values.

      Returns void

      Example

      mobilelocker.data.submitForm('lead-form', { firstName: 'Jane', email: 'jane@example.com' })
      Copy

• database: {
      describe(
          database: string,
          table: string,
      ): Promise<DatabaseTableDescription>;
      list(): Promise<string[]>;
      query(
          path: string,
          sql: string,
          parameters?: Record<string, unknown> | unknown[],
      ): Promise<DatabaseQueryResult>;
  }

  • describe: function

    • describe(database: string, table: string): Promise<DatabaseTableDescription>

      Describe the schema of a table in a SQLite database.

      In local development, falls back to sql.js and reads the schema directly from the database file via PRAGMA table_info.

      Parameters

      • database: string

        Path to the .sqlite file (relative to the presentation root).

      • table: string

        Name of the table to inspect.

      Returns Promise<DatabaseTableDescription>

      A DatabaseTableDescription with name, sql, and columns.

      Throws

      MobileLockerDatabaseError with code InvalidPath if the table does not exist.

      Example

      const schema = await mobilelocker.database.describe('data/products.sqlite', 'products')
      console.log(schema.columns.map(c => c.name))
      Copy

  • list: function

    • list(): Promise<string[]>

      List the SQLite database files available to the current presentation.

      Returns Promise<string[]>

      Array of database file path strings.

      Remarks

      Returns an empty array outside the Mobile Locker app.

      Throws

      MobileLockerDatabaseError on network failure or server error.

  • query: function

    • query(
          path: string,
          sql: string,
          parameters?: Record<string, unknown> | unknown[],
      ): Promise<DatabaseQueryResult>

      Execute a SQL SELECT query against a SQLite database embedded in the presentation.

      In local development, falls back to sql.js and fetches the database file directly. Only SELECT statements are permitted — write operations throw WriteNotPermitted.

      Parameters

      • path: string

        Path to the .sqlite file (relative to the presentation root).

      • sql: string

        A SQL SELECT statement, optionally with ? or :name placeholders.

      • parameters: Record<string, unknown> | unknown[] = []

        Positional array or named object of bind parameters.

      Returns Promise<DatabaseQueryResult>

      A DatabaseQueryResult with rows, rows_affected, and last_insert_row_id.

      Throws

      MobileLockerDatabaseError with codes InvalidPath, WriteNotPermitted, NotReady, QueryFailed, or NotConnected.

      Example

      const result = await mobilelocker.database.query(
        'data/products.sqlite',
        'SELECT * FROM products WHERE category = ?',
        ['widgets']
      )
      result.rows.forEach(row => console.log(row.name))
      Copy

• device: {
      get(): Promise<DeviceInfo | null>;
      isAtLeastVersion(version: string): Promise<boolean>;
  }

  • get: function

    • get(): Promise<DeviceInfo | null>

      Get hardware and app metadata for the current device.

      Returns Promise<DeviceInfo | null>

      A DeviceInfo object, or null outside the iOS app.

      Remarks

      iOS app only. Returns null in all other environments.

      Example

      const info = await mobilelocker.device.get()
      if (info) console.log(info.app.version, info.hardware.model)
      Copy

  • isAtLeastVersion: function

    • isAtLeastVersion(version: string): Promise<boolean>

      Check whether the Mobile Locker app version meets a minimum requirement.

      Parameters

      • version: string

        Minimum required version string in major.minor.patch format (e.g. '5.2.0').

      Returns Promise<boolean>

      true if the current app version is equal to or greater than version.

      Remarks

      iOS app only. Returns false in all other environments.

      Example

      if (await mobilelocker.device.isAtLeastVersion('5.2.0')) {
        // use a feature introduced in 5.2.0
      }
      Copy

• http: {
      request: (
          url: string,
          options?: HTTPRequestOptions,
      ) => Promise<HTTPResponse>;
      delete(url: string, options?: HTTPOptions): Promise<HTTPResponse>;
      get(url: string, options?: HTTPOptions): Promise<HTTPResponse>;
      patch(
          url: string,
          body?: unknown,
          options?: HTTPOptions,
      ): Promise<HTTPResponse>;
      post(
          url: string,
          body?: unknown,
          options?: HTTPOptions,
      ): Promise<HTTPResponse>;
      put(
          url: string,
          body?: unknown,
          options?: HTTPOptions,
      ): Promise<HTTPResponse>;
  }

  • request: (url: string, options?: HTTPRequestOptions) => Promise<HTTPResponse>

    Make an HTTP request with full control over method and options.

    Throws

    MobileLockerHTTPError on network failure or timeout.

    Throws

    MobileLockerHttpResponseError on non-2xx responses.

  • delete: function

    • delete(url: string, options?: HTTPOptions): Promise<HTTPResponse>

      Make a DELETE request to an external URL.

      Parameters

      • url: string

        The full URL to request.

      • Optionaloptions: HTTPOptions

        Optional headers, timeout, and response type.

      Returns Promise<HTTPResponse>

      An HTTPResponse.

      Throws

      MobileLockerHTTPError on network failure or timeout.

      Throws

      MobileLockerHttpResponseError on non-2xx responses.

  • get: function

    • get(url: string, options?: HTTPOptions): Promise<HTTPResponse>

      Make a GET request to an external URL.

      In the iOS app, requests are proxied through the native layer to bypass CORS. In the browser, standard fetch is used and CORS rules apply.

      Parameters

      • url: string

        The full URL to request.

      • Optionaloptions: HTTPOptions

        Optional headers, timeout, and response type.

      Returns Promise<HTTPResponse>

      An HTTPResponse with status, statusText, headers, and data.

      Throws

      MobileLockerHTTPError on network failure or timeout.

      Throws

      MobileLockerHttpResponseError on non-2xx responses.

  • patch: function

    • patch(url: string, body?: unknown, options?: HTTPOptions): Promise<HTTPResponse>

      Make a PATCH request to an external URL.

      Parameters

      • url: string

        The full URL to request.

      • Optionalbody: unknown

        Request body, serialized as JSON.

      • Optionaloptions: HTTPOptions

        Optional headers, timeout, and response type.

      Returns Promise<HTTPResponse>

      An HTTPResponse.

      Throws

      MobileLockerHTTPError on network failure or timeout.

      Throws

      MobileLockerHttpResponseError on non-2xx responses.

  • post: function

    • post(url: string, body?: unknown, options?: HTTPOptions): Promise<HTTPResponse>

      Make a POST request to an external URL.

      Parameters

      • url: string

        The full URL to request.

      • Optionalbody: unknown

        Request body, serialized as JSON.

      • Optionaloptions: HTTPOptions

        Optional headers, timeout, and response type.

      Returns Promise<HTTPResponse>

      An HTTPResponse.

      Throws

      MobileLockerHTTPError on network failure or timeout.

      Throws

      MobileLockerHttpResponseError on non-2xx responses.

  • put: function

    • put(url: string, body?: unknown, options?: HTTPOptions): Promise<HTTPResponse>

      Make a PUT request to an external URL.

      Parameters

      • url: string

        The full URL to request.

      • Optionalbody: unknown

        Request body, serialized as JSON.

      • Optionaloptions: HTTPOptions

        Optional headers, timeout, and response type.

      Returns Promise<HTTPResponse>

      An HTTPResponse.

      Throws

      MobileLockerHTTPError on network failure or timeout.

      Throws

      MobileLockerHttpResponseError on non-2xx responses.

• isApp: () => boolean

• isCDN: () => boolean

• isElectron: () => boolean

• isIOS: () => boolean

• isMobileLocker: () => boolean

• log: {
      clearSdkLogs(): Promise<void>;
      debug(message: string, metadata?: Record<string, unknown>): void;
      deleteSdkLog(id: number): Promise<void>;
      error(message: string, metadata?: Record<string, unknown>): void;
      getSdkLogs(filter?: SDKLogFilter): Promise<SDKLogEntry[]>;
      info(message: string, metadata?: Record<string, unknown>): void;
      isEnabled(): boolean;
      liveMode(uri?: string): void;
      practiceMode(uri?: string): void;
      searchSdkLogs(text: string, filter?: SDKLogFilter): Promise<SDKLogEntry[]>;
      setMode(enabled: boolean): void;
      warn(message: string, metadata?: Record<string, unknown>): void;
  }

  • clearSdkLogs: function

    • clearSdkLogs(): Promise<void>

      Delete all SDK log entries for the current presentation and user.

      Returns Promise<void>

      Throws

      MobileLockerError on network failure or server error.

  • debug: function

    • debug(message: string, metadata?: Record<string, unknown>): void

      Write a debug-level log entry into the SDK log store.

      Parameters

      • message: string

        Human-readable description of the event.

      • Optionalmetadata: Record<string, unknown>

        Optional key/value data to attach to the entry.

      Returns void

  • deleteSdkLog: function

    • deleteSdkLog(id: number): Promise<void>

      Delete a single SDK log entry by ID.

      Parameters

      • id: number

        The numeric ID of the entry to delete.

      Returns Promise<void>

      Throws

      MobileLockerError on network failure or server error.

  • error: function

    • error(message: string, metadata?: Record<string, unknown>): void

      Write an error-level log entry into the SDK log store.

      Parameters

      • message: string

        Human-readable description of the event.

      • Optionalmetadata: Record<string, unknown>

        Optional key/value data to attach to the entry.

      Returns void

  • getSdkLogs: function

    • getSdkLogs(filter?: SDKLogFilter): Promise<SDKLogEntry[]>

      Retrieve structured SDK log entries with optional filtering.

      In the iOS app, fetches from the server-side GRDB table scoped to the current team, user, presentation, and device session. Outside the app, reads from IndexedDB via localforage (same entry shape, up to 1,000 entries).

      Parameters

      • Optionalfilter: SDKLogFilter

        Optional filter by level, domain, function, date range, retries, and limit.

      Returns Promise<SDKLogEntry[]>

      Array of SDKLogEntry objects, newest first.

      Throws

      MobileLockerError on network failure or server error.

      Example

      const errors = await mobilelocker.log.getSdkLogs({ level: 'error', domain: 'crm' })
      Copy

  • info: function

    • info(message: string, metadata?: Record<string, unknown>): void

      Write an info-level log entry into the SDK log store.

      Parameters

      • message: string

        Human-readable description of the event.

      • Optionalmetadata: Record<string, unknown>

        Optional key/value data to attach to the entry.

      Returns void

      Example

      mobilelocker.log.info('User selected product', { productId: 42, slide: 'overview' })
      Copy

  • isEnabled: function

    • isEnabled(): boolean

      Check whether debug mode is currently enabled.

      Returns boolean

      true if debug mode is on.

  • liveMode: function

    • liveMode(uri?: string): void

      Mark the current session as a live (non-practice) presentation.

      Parameters

      • uri: string = ''

        Optional URI or identifier to associate with the event.

      Returns void

  • practiceMode: function

    • practiceMode(uri?: string): void

      Mark the current session as a practice presentation.

      Parameters

      • uri: string = ''

        Optional URI or identifier to associate with the event.

      Returns void

  • searchSdkLogs: function

    • searchSdkLogs(text: string, filter?: SDKLogFilter): Promise<SDKLogEntry[]>

      Full-text search across SDK log entries.

      Searches the message field and stringified metadata. Accepts the same filter options as getSdkLogs to narrow the scope before searching.

      Parameters

      • text: string

        The search string.

      • Optionalfilter: SDKLogFilter

        Optional pre-filter applied before the text search.

      Returns Promise<SDKLogEntry[]>

      Array of matching SDKLogEntry objects.

      Throws

      MobileLockerError on network failure or server error.

  • setMode: function

    • setMode(enabled: boolean): void

      Enable or disable debug mode.

      Parameters

      • enabled: boolean

        Pass true to enable, false to disable.

      Returns void

  • warn: function

    • warn(message: string, metadata?: Record<string, unknown>): void

      Write a warn-level log entry into the SDK log store.

      Parameters

      • message: string

        Human-readable description of the event.

      • Optionalmetadata: Record<string, unknown>

        Optional key/value data to attach to the entry.

      Returns void

• MobileLockerError: typeof MobileLockerError

• network: { getStatus(): Promise<NetworkStatus> }

  • getStatus: function

    • getStatus(): Promise<NetworkStatus>

      Get the current network connectivity status.

      In the iOS app, returns accurate connection type from the native layer. In the browser, falls back to navigator.onLine — note that this may return true on captive portals even without real internet access.

      Returns Promise<NetworkStatus>

      A NetworkStatus object with connected and type.

      Example

      const { connected, type } = await mobilelocker.network.getStatus()
      if (!connected) showOfflineBanner()
      Copy

• notificationLevels: {
      NOTIFY_EVERY: number;
      NOTIFY_FIRST: number;
      NOTIFY_MONTHLY: number;
      NOTIFY_NONE: number;
      NOTIFY_WEEKLY: number;
  }

• presentation: {
      close(): void;
      download(id: number): Promise<{ status: DownloadStatus }>;
      get(): Promise<Presentation>;
      getAll(): Promise<Presentation[]>;
      getByID(id: number): Promise<Presentation>;
      getByName(name: string): Promise<Presentation>;
      getDeviceEvents(): Promise<unknown[]>;
      getEvents(): Promise<unknown[]>;
      openByExternalID(externalID: string): void;
      openByID(id: number): void;
      openByName(name: string): void;
      openPicker(): void;
      refresh(): Promise<Presentation[]>;
      reload(): void;
  }

  • close: function

    • close(): void

      Close the current presentation and return to the app home screen.

      Returns void

  • download: function

    • download(id: number): Promise<{ status: DownloadStatus }>

      Queue a presentation for download to the device.

      Parameters

      • id: number

        The numeric ID of the presentation to download.

      Returns Promise<{ status: DownloadStatus }>

      An object with status: 'queued', 'already_installed', 'not_available', or 'not_permitted'.

      Throws

      MobileLockerError on network failure or server error.

  • get: function

    • get(): Promise<Presentation>

      Get the presentation that is currently open.

      Returns Promise<Presentation>

      The current Presentation.

      Throws

      MobileLockerError on network failure or server error.

  • getAll: function

    • getAll(): Promise<Presentation[]>

      Get all presentations available to the current user.

      Returns Promise<Presentation[]>

      Array of Presentation objects.

      Throws

      MobileLockerError on network failure or server error.

  • getByID: function

    • getByID(id: number): Promise<Presentation>

      Get a presentation by its numeric ID.

      Parameters

      • id: number

        The presentation ID.

      Returns Promise<Presentation>

      The matching Presentation.

      Throws

      MobileLockerError on network failure, or if not found.

  • getByName: function

    • getByName(name: string): Promise<Presentation>

      Get a presentation by its name.

      Parameters

      • name: string

        The presentation name (case-sensitive).

      Returns Promise<Presentation>

      The matching Presentation.

      Throws

      MobileLockerError on network failure, or if not found.

  • getDeviceEvents: function

    • getDeviceEvents(): Promise<unknown[]>

      Alias for getEvents.

      Returns Promise<unknown[]>

      Array of raw event objects.

  • getEvents: function

    • getEvents(): Promise<unknown[]>

      Get the analytics events recorded for the current presentation session.

      Returns Promise<unknown[]>

      Array of raw event objects.

      Throws

      MobileLockerError on network failure or server error.

  • openByExternalID: function

    • openByExternalID(externalID: string): void

      Open a presentation by its external CRM ID.

      Parameters

      • externalID: string

        The external identifier for the presentation (e.g. a Salesforce ID).

      Returns void

      Remarks

      iOS app only. Throws in all other environments.

      Throws

      MobileLockerError if called outside the iOS app.

  • openByID: function

    • openByID(id: number): void

      Open a presentation by its numeric ID.

      Parameters

      • id: number

        The numeric ID of the presentation to open.

      Returns void

      Remarks

      iOS app only. Throws in all other environments.

      Throws

      MobileLockerError if called outside the iOS app.

  • openByName: function

    • openByName(name: string): void

      Open a presentation by its name.

      Parameters

      • name: string

        The presentation name (case-sensitive).

      Returns void

      Remarks

      iOS app only. Throws in all other environments.

      Throws

      MobileLockerError if called outside the iOS app.

  • openPicker: function

    • openPicker(): void

      Open the native presentation picker so the user can choose a presentation to open.

      Returns void

      Remarks

      iOS app only. Throws in all other environments.

      Throws

      MobileLockerError if called outside the iOS app.

  • refresh: function

    • refresh(): Promise<Presentation[]>

      Refresh the list of available presentations from the server.

      Returns Promise<Presentation[]>

      Updated array of Presentation objects.

      Throws

      MobileLockerError on network failure or server error.

  • reload: function

    • reload(): void

      Reload the current presentation's web content.

      Triggers a full page reload inside the presentation webview.

      Returns void

• scanner: {
      scanBadge(eventID: number): Promise<ScanResult>;
      scanBusinessCard(eventID?: number): Promise<ScanResult>;
  }

  • scanBadge: function

    • scanBadge(eventID: number): Promise<ScanResult>

      Open the native badge scanner and capture an event attendee.

      Parameters

      • eventID: number

        The lead retrieval event ID to associate the scan with.

      Returns Promise<ScanResult>

      A ScanResult — check status before accessing attendee.

      Remarks

      iOS app only. Throws in all other environments.

      Throws

      MobileLockerError if called outside the iOS app.

      Example

      const result = await mobilelocker.scanner.scanBadge(eventID)
      if (result.status === 'success') console.log(result.attendee)
      Copy

  • scanBusinessCard: function

    • scanBusinessCard(eventID?: number): Promise<ScanResult>

      Open the native business card scanner and capture a contact.

      Parameters

      • OptionaleventID: number

        Optional lead retrieval event ID to associate the scan with.

      Returns Promise<ScanResult>

      A ScanResult — check status before accessing businessCard.

      Remarks

      iOS app only. Throws in all other environments.

      Throws

      MobileLockerError if called outside the iOS app.

      Example

      const result = await mobilelocker.scanner.scanBusinessCard()
      if (result.status === 'success') console.log(result.businessCard)
      Copy

• search: { query(text: string, options?: SearchOptions): Promise<SearchResults> }

  • query: function

    • query(text: string, options?: SearchOptions): Promise<SearchResults>

      Search across multiple entity types simultaneously.

      Returns results grouped by type. Use options.types to restrict the search to specific entities and options.limit to control result set size per type.

      Parameters

      • text: string

        The search string.

      • options: SearchOptions = {}

        Optional filter for entity types and result limit.

      Returns Promise<SearchResults>

      A SearchResults object with a result set for each entity type.

      Throws

      MobileLockerError on network failure or server error.

      Example

      const results = await mobilelocker.search.query('Acme', { types: ['customers'], limit: 10 })
      results.customers.results.forEach(c => console.log(c.name))
      Copy

• session: { getDeviceEvents(): Promise<unknown[]> }

  • getDeviceEvents: function

    • getDeviceEvents(): Promise<unknown[]>

      Get all analytics events recorded during the current device session.

      In the iOS app, fetches events from the server scoped to the current session. Outside the app (local development), returns events buffered in IndexedDB via localforage.

      Returns Promise<unknown[]>

      Array of raw event objects.

• share: {
      email(
          to: string | { email: string; name?: string },
          subject: string,
          body?: string | null,
          attachment?: string | null,
          template?: string | null,
          formData?: unknown,
      ): void;
      presentation(
          recipients: ShareRecipient[],
          notificationLevel?: number,
          sendReminders?: boolean,
      ): void;
  }

  • email: function

    • email(
          to: string | { email: string; name?: string },
          subject: string,
          body?: string | null,
          attachment?: string | null,
          template?: string | null,
          formData?: unknown,
      ): void

      Send an email through the Mobile Locker platform.

      Parameters

      • to: string | { email: string; name?: string }

        Recipient email string, or an object with email and optional name.

      • subject: string

        Email subject line.

      • body: string | null = null

        Optional email body text.

      • attachment: string | null = null

        Optional path to a file to attach.

      • template: string | null = null

        Optional email template identifier.

      • formData: unknown = null

        Optional additional form data to include with the email record.

      Returns void

      Example

      mobilelocker.share.email(
        { name: 'Jane', email: 'jane@example.com' },
        'Thanks for stopping by',
        'It was great meeting you at the conference.',
      )
      Copy

  • presentation: function

    • presentation(
          recipients: ShareRecipient[],
          notificationLevel?: number,
          sendReminders?: boolean,
      ): void

      Share the current presentation with one or more recipients.

      Sends the presentation link via the Mobile Locker platform. No-op outside the Mobile Locker environment (e.g. local development).

      Parameters

      • recipients: ShareRecipient[]

        One or more recipients, each requiring at least an email.

      • notificationLevel: number = 2

        Controls when recipients receive email notifications. Use the mobilelocker.notificationLevels constants. Defaults to NOTIFY_EVERY (2).

      • sendReminders: boolean = true

        Whether to send follow-up reminder emails. Defaults to true.

      Returns void

      Throws

      MobileLockerError if recipients is empty or any recipient is missing an email.

      Example

      mobilelocker.share.presentation(
        [{ email: 'jane@example.com', name: 'Jane' }],
        mobilelocker.notificationLevels.NOTIFY_FIRST,
      )
      Copy

• storage: {
      delete(name: string): Promise<void>;
      get(name: string): Promise<StorageEntry | null>;
      getAll(): Promise<StorageEntry[]>;
      getAllForPresentation(): Promise<StorageEntry[]>;
      getForPresentation(presentationID: number): Promise<StorageEntry[]>;
      query(filter?: StorageFilter): Promise<StorageEntry[]>;
      save(name: string, data: unknown): Promise<StorageEntry>;
      search(text: string, filter?: StorageFilter): Promise<StorageEntry[]>;
  }

  • delete: function

    • delete(name: string): Promise<void>

      Delete the storage entry with the given name.

      Parameters

      • name: string

        The key name of the entry to delete.

      Returns Promise<void>

      Throws

      MobileLockerError on network failure or server error.

  • get: function

    • get(name: string): Promise<StorageEntry | null>

      Get a single storage entry by name for the current presentation and user.

      Parameters

      • name: string

        The key name of the entry to retrieve.

      Returns Promise<StorageEntry | null>

      The matching StorageEntry, or null if not found.

      Throws

      MobileLockerError on network failure or server error.

  • getAll: function

    • getAll(): Promise<StorageEntry[]>

      Get all storage entries for the current presentation and user.

      Returns Promise<StorageEntry[]>

      Array of StorageEntry objects.

      Throws

      MobileLockerError on network failure or server error.

  • getAllForPresentation: function

    • getAllForPresentation(): Promise<StorageEntry[]>

      Get all storage entries for the current user across all presentations.

      Returns Promise<StorageEntry[]>

      Array of StorageEntry objects.

      Throws

      MobileLockerError on network failure or server error.

  • getForPresentation: function

    • getForPresentation(presentationID: number): Promise<StorageEntry[]>

      Get all storage entries for a specific presentation by ID.

      Parameters

      • presentationID: number

        The numeric ID of the presentation.

      Returns Promise<StorageEntry[]>

      Array of StorageEntry objects.

      Throws

      MobileLockerError on network failure or server error.

  • query: function

    • query(filter?: StorageFilter): Promise<StorageEntry[]>

      Query storage entries with optional filtering.

      Outside the Mobile Locker app, filters are applied locally against IndexedDB.

      Parameters

      • Optionalfilter: StorageFilter

        Optional filter by name, presentation, date range, and limit.

      Returns Promise<StorageEntry[]>

      Array of matching StorageEntry objects.

      Throws

      MobileLockerError on network failure or server error.

      Example

      const entries = await mobilelocker.storage.query({ name: 'scan-results', limit: 10 })
      Copy

  • save: function

    • save(name: string, data: unknown): Promise<StorageEntry>

      Save a value to storage under the given name.

      Creates a new entry if one does not exist, or updates the existing entry. Outside the Mobile Locker app, persists to IndexedDB via localforage.

      Parameters

      • name: string

        The key name for the entry.

      • data: unknown

        Any JSON-serializable value to store.

      Returns Promise<StorageEntry>

      The saved StorageEntry.

      Throws

      MobileLockerError on network failure or server error.

      Example

      await mobilelocker.storage.save('scan-results', { leads: [...] })
      Copy

  • search: function

    • search(text: string, filter?: StorageFilter): Promise<StorageEntry[]>

      Full-text search across storage entry names and data.

      Parameters

      • text: string

        The search string. Matched against name and the stringified data.

      • Optionalfilter: StorageFilter

        Optional pre-filter applied before the text search.

      Returns Promise<StorageEntry[]>

      Array of matching StorageEntry objects.

      Throws

      MobileLockerError on network failure or server error.

• ui: {
      openPDF(
          pdfPath: string,
          title: string,
          customOptions?: Record<string, unknown>,
      ): void;
      openVideo(path: string, options?: VideoOptions): Promise<VideoResult>;
      showToolbar(): void;
  }

  • openPDF: function

    • openPDF(
          pdfPath: string,
          title: string,
          customOptions?: Record<string, unknown>,
      ): void

      Open a PDF file in the platform viewer.

      In the iOS app, opens the native PDF viewer with annotation support. In the browser, opens the file in a new tab.

      Parameters

      • pdfPath: string

        Path to the PDF file, relative to the presentation root.

      • title: string

        Display title for the viewer.

      • OptionalcustomOptions: Record<string, unknown>

        Optional extra properties passed through to the analytics event.

      Returns void

      Example

      mobilelocker.ui.openPDF('/files/brochure.pdf', 'Product Brochure')
      Copy

  • openVideo: function

    • openVideo(path: string, options?: VideoOptions): Promise<VideoResult>

      Open a video file in the platform player.

      In the iOS app, uses the native AVPlayer with full option support. In the browser, renders a full-viewport <video> overlay. Click outside the video to dismiss it.

      Parameters

      • path: string

        Path to the video file, relative to the presentation root.

      • options: VideoOptions = {}

        Playback options (autoplay, loop, controls, speed, etc.).

      Returns Promise<VideoResult>

      A VideoResult with status and final playback position in seconds.

      Example

      const result = await mobilelocker.ui.openVideo('/files/demo.mp4', { autoplay: true, showControls: true })
      if (result.status === 'completed') console.log(`Watched to ${result.position}s`)
      Copy

  • showToolbar: function

    • showToolbar(): void

      Show the app navigation toolbar.

      Returns void

      Remarks

      iOS app only. Throws in all other environments.

      Throws

      MobileLockerError if called outside the iOS app.

• user: { get(): Promise<User> }

  • get: function

    • get(): Promise<User>

      Get the currently authenticated user.

      Returns Promise<User>

      The authenticated User.

      Throws

      MobileLockerError on network failure or server error.

      Example

      const u = await mobilelocker.user.get()
      console.log(`Hello, ${u.name}`)
      Copy