log

const log: {
  setMode: void;
  isEnabled: boolean;
  liveMode: void;
  practiceMode: void;
  getSdkLogs: Promise<SDKLogEntry[]>;
  searchSdkLogs: Promise<SDKLogEntry[]>;
  debug: void;
  info: void;
  warn: void;
  error: void;
};

Defined in: domains/log.ts:84

Type Declaration

setMode()

setMode(enabled): void;

Enable or disable debug mode.

Parameters

Parameter	Type	Description
enabled	boolean	Pass true to enable, false to disable.

Returns

void

isEnabled()

isEnabled(): boolean;

Check whether debug mode is currently enabled.

Returns

boolean

true if debug mode is on.

liveMode()

liveMode(uri?): void;

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

Parameters

Parameter	Type	Default value	Description
uri	string	''	Optional URI or identifier to associate with the event.

Returns

void

practiceMode()

practiceMode(uri?): void;

Mark the current session as a practice presentation.

Parameters

Parameter	Type	Default value	Description
uri	string	''	Optional URI or identifier to associate with the event.

Returns

void

getSdkLogs()

getSdkLogs(filter?): 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

Parameter	Type	Description
filter?	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' })

searchSdkLogs()

searchSdkLogs(text, filter?): 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

Parameter	Type	Description
text	string	The search string.
filter?	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()

debug(message, metadata?): void;

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

Parameters

Parameter	Type	Description
message	string	Human-readable description of the event.
metadata?	Record<string, unknown>	Optional key/value data to attach to the entry.

Returns

void

info()

info(message, metadata?): void;

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

Parameters

Parameter	Type	Description
message	string	Human-readable description of the event.
metadata?	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' })

warn()

warn(message, metadata?): void;

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

Parameters

Parameter	Type	Description
message	string	Human-readable description of the event.
metadata?	Record<string, unknown>	Optional key/value data to attach to the entry.

Returns

void

error()

error(message, metadata?): void;

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

Parameters

Parameter	Type	Description
message	string	Human-readable description of the event.
metadata?	Record<string, unknown>	Optional key/value data to attach to the entry.

Returns

void