Skip to content

@collectivtech/alana-sdk-js


@collectivtech/alana-sdk-js / resources/experience / ExperienceShareOptions

Interface: ExperienceShareOptions ​

Defined in: src/resources/experience.ts:129

Options for sharing an experience with another user.

Properties ​

email? ​

optional email?: string

Defined in: src/resources/experience.ts:135

The email address of the recipient, who may or may not be an ALANA Platform user.

Either the email address or the phone number must be provided.


phone? ​

optional phone?: string

Defined in: src/resources/experience.ts:142

The phone number of the recipient, who may or may not be an ALANA Platform user.

Either the email address or the phone number must be provided.


text? ​

optional text?: string

Defined in: src/resources/experience.ts:155

Additional text that will be included in the share notification. If this isn't provided, then generic text will be used instead.


url ​

url: string

Defined in: src/resources/experience.ts:149

The target URL of the experience. Note that this is not automatically derived from any ALANA API responses, as it is intended to be an experience that is displayed on an ALANA partner site.

ALANA™, ALANA Platform™, ALANA Guide™, and ALANA Partner™ are trademarks of Collectiv Technologies Inc.