share

const share: {
  presentation: void;
  email: void;
};

Defined in: domains/share.ts:13

Type Declaration

presentation()

presentation(
   recipients,
   notificationLevel?,
   sendReminders?): 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

Parameter	Type	Default value	Description
recipients	ShareRecipient[]	undefined	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,
)

email()

email(
   to,
   subject,
   body?,
   attachment?,
   template?,
   formData?): void;

Send an email through the Mobile Locker platform.

Parameters

Parameter	Type	Default value	Description
to	| string | { name?: string; email: string; }	undefined	Recipient email string, or an object with email and optional name.
subject	string	undefined	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.',
)