@acceleratxr/core_sdk / QuestDefinition
Class: QuestDefinition#
Describes a single quest.
REQUIRES: Quest Services
author Jean-Philippe Steinmetz info@acceleratxr.com
Hierarchy#
-
↳ QuestDefinition
Index#
Constructors#
Properties#
Accessors#
Constructors#
constructor#
+ new QuestDefinition(other?: any): QuestDefinition
Overrides EntityBase.constructor
Defined in src/models/QuestDefinition.ts:88
Parameters:#
Name |
Type |
|---|---|
|
any |
Returns: QuestDefinition
Properties#
autostart#
• autostart: boolean = false
Defined in src/models/QuestDefinition.ts:83
Set to true to have quests automatically start tracking progress once unlocked, otherwise set to false. Default value is false.
data#
• data: any = null
Defined in src/models/QuestDefinition.ts:88
Stores any custom data to be used by the product.
dateAvailable#
• dateAvailable: Date | undefined = undefined
Defined in src/models/QuestDefinition.ts:63
The date and time that the quest will be first made available. A null value indicates immediately available.
dateCreated#
• dateCreated: Date = new Date()
Inherited from EntityBase.dateCreated
Defined in src/EntityBase.ts:18
The date and time that the object was created.
dateFinished#
• dateFinished: Date | undefined = undefined
Defined in src/models/QuestDefinition.ts:68
The date and time that the quest will no longer be available. A null value indicates no end date.
dateModified#
• dateModified: Date = new Date()
Inherited from EntityBase.dateModified
Defined in src/EntityBase.ts:23
The date and time that the object was last modified.
description#
• description: string = “”
Defined in src/models/QuestDefinition.ts:31
A textual description of the quest.
entityUid#
• entityUid: string = “”
Defined in src/models/QuestDefinition.ts:41
The universally unique identifier of the entity that gives out the quest.
frequency#
• frequency: string = “”
Defined in src/models/QuestDefinition.ts:73
The frequency that the quest can be repeated (e.g. 5m, 1h, 1w). A null value indicates that the quest cannot be repeated.
icon#
• icon: string = “”
Defined in src/models/QuestDefinition.ts:36
The icon to display when representing the quest.
name#
• name: string = “”
Defined in src/models/QuestDefinition.ts:21
The unique name of the quest.
productUid#
• productUid: string | undefined = undefined
Defined in src/models/QuestDefinition.ts:48
The uid of the product that this definition is associated with.
REQUIRES: Quest Services.
requirements#
• requirements: QuestRequirement[] = []
Defined in src/models/QuestDefinition.ts:53
The list of requirements that the persona must fulfill to complete the quest.
rewards#
• rewards: QuestReward[] = []
Defined in src/models/QuestDefinition.ts:58
The list of rewards that will be given once the quest has been completed.
title#
• title: string = “”
Defined in src/models/QuestDefinition.ts:26
A textual title or name of the quest.
uid#
• uid: string = uuid.v4()
Inherited from EntityBase.uid
Defined in src/EntityBase.ts:13
The universally unique identifier of the object.
unlockRequirements#
• unlockRequirements: QuestRequirement[] = []
Defined in src/models/QuestDefinition.ts:78
The list of requirements that the persona must meet to unlock the quest.
version#
• version: number = 0
Inherited from EntityBase.version
Defined in src/EntityBase.ts:28
The optimistic locking version of the object.
Accessors#
ClassName#
• Staticget ClassName(): string
Defined in src/models/QuestDefinition.ts:16
Returns: string