Variable logConst

Type Declaration

• setMode: function

  • setMode(enabled: boolean): void

    Enable or disable debug mode.

    Parameters

    • enabled: boolean

      Pass true to enable, false to disable.

    Returns void

• 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

• 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

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

• 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

• 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

• 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

• 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