Class DialogueResponsePowers

Run the skill if a user requests additional data.

 import { ISkillContext, ShouldIRunResponseType } from "andiskills";
 import { DialogueResponsePowers } from "@andi/powers";

 // shouldIRun is used by the andi skills platform to determine if the given
 // skill's current context needs to be executed.
 export async function shouldIRun(skillContext: ISkillContext): Promise<ShouldIRunResponseType> {

    // Run skill if user requests additional data
     if (DialogueResponsePowers.isGetAdditionalTagDataEvent()) {
         return skillContext.powers.andi.shouldIRun.shouldIRunTrue();
     }

     return skillContext.powers.andi.shouldIRun.shouldIRunFalse();
 }

{Error} When dialogue options are missing or when included dialogue tags are null or are missing a name.

{TypeError} When options is an invalid type.

In this example a DialogTag is returned with a helpful article in the Andi Dialog

//Ensure you import DialogueResponsePowers
//import {  DialogueResponsePowers, DialogueResponse} from "@andi/powers";
 const tag: DialogueTag = {
     name: "Test dialogue tag",
     tagType: FieldTagTypes.Info,
     text: "Here is a test help article.",
     onClick: [{
         name: "openNewTab",
         args: [articleUrl]
     }]
 };

 const dialogueResponse: DialogueResponse = {
     message: "I found this helpful article:",
     tags: [tag]
 };

 return DialogueResponsePowers.sendDialogueResponseWithTags(dialogueResponse);

In this example returns two dialog response with helpful articles

// Ensure you import DialogueResponsePowers
// import {  DialogueResponsePowers, DialogueResponse} from "@andi/powers";

 const tag1: DialogueTag = {
     name: "Test dialogue tag",
     tagType: FieldTagTypes.Info,
     text: "Here is a test help article.",
     onClick: [{
         name: "openNewTab",
         args: [articleUrl]
     }]
 };

 const dialogueResponse1: DialogueResponse = {
     message: "I found this helpful article:",
     tags: [tag1]
 };

 const tag2: DialogueTag = {
     name: "Test dialogue tag",
     tagType: FieldTagTypes.Info,
     text: "Here is a test help article.",
     onClick: [{
         name: "openNewTab",
         args: [articleUrl]
     }]
 };

 const dialogueResponse2: DialogueResponse = {
     message: "I found this helpful article:",
     tags: [tag2]
 };

 return DialogueResponsePowers.sendDialogueResponses([dialogueResponse1,dialogueResponse2]);

{Error} When options is not an array with at least one dialogue response.

{Error} When any included dialogue tags are null or missing a name.