Interface EditorMessageTutorialProgressEventRequest

interface EditorMessageTutorialProgressEventRequest {
    action: "tutorialevent";
    currentStep: number;
    frameId?: string;
    id?: string;
    isCompleted: boolean;
    projectHeaderId: string;
    response?: boolean;
    totalSteps: number;
    tutorialEvent: "progress";
    tutorialId: string;
    type: "pxteditor" | "pxthost" | "pxtpkgext" | "pxtsim";
}

Hierarchy

  • EditorMessageRequest
    • EditorMessageTutorialProgressEventRequest

Properties

action currentStep frameId? id? isCompleted projectHeaderId response? totalSteps tutorialEvent tutorialId type

Properties

action

action: "tutorialevent"

Request action

currentStep

currentStep: number

OptionalframeId

frameId?: string

Frame identifier that can be passed to the iframe by adding the frameId query parameter

Optionalid

id?: string

Original request id

isCompleted

isCompleted: boolean

projectHeaderId

projectHeaderId: string

Optionalresponse

response?: boolean

flag to request response

totalSteps

totalSteps: number

tutorialEvent

tutorialEvent: "progress"

tutorialId

tutorialId: string

type

type: "pxteditor" | "pxthost" | "pxtpkgext" | "pxtsim"

Constant identifier

Settings

Member Visibility

On This Page

Properties