Variable storageConst

Type Declaration

• 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

• 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.

• 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

• 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.