Skip to content

@collectivtech/alana-sdk-js


@collectivtech/alana-sdk-js / resources/server/experience / Experiences

Class: Experiences ​

Defined in: src/resources/server/experience.ts:111

Base class for an API resource object.

This is an abstract class. You shouldn't create objects from it directly, but instead use one of the defined subclasses, which handle the needed conversion to and from raw JSON.

All resource classes hold a reference to a context object, and this may be a shared object to allow for state tracking.

Extends ​

Constructors ​

Constructor ​

new Experiences(context): Experiences

Defined in: src/resources/server/experience.ts:117

Create a new Experiences resource for the Server API.

Parameters ​

context ​

ApiContext

The API context used for this resource.

Returns ​

Experiences

Overrides ​

ApiResource.constructor

Properties ​

_context ​

protected _context: ApiContext

Defined in: src/resource.ts:148

The API context for this resource.

Inherited from ​

ApiResource._context

Methods ​

createTag() ​

createTag(data): Promise<ThemeTag>

Defined in: src/resources/server/experience.ts:188

Create a new theme tag for experiences.

Parameters ​

data ​

ThemeTagOptions

The text for the tag and its category

Returns ​

Promise<ThemeTag>

An object with a tag ID for confirmation


fromClient() ​

fromClient(experience): ServerExperience

Defined in: src/resources/server/experience.ts:121

Parameters ​

experience ​

Experience

Returns ​

ServerExperience


listEditable() ​

listEditable(): Promise<ServerExperience[]>

Defined in: src/resources/server/experience.ts:170

List the experiences the active user is able to edit. This includes all experiences created by businesses that the user either has created or has access to.

Returns ​

Promise<ServerExperience[]>

An array of Experience resources

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