Magidoc

Tutorial
Object

A staff-authored in-app tutorial (a coach-mark / product tour) played inside Cloudshelf Manager. Runs once per user when published and eligible for that user.

Fields

#

audience

TutorialAudience !
Non-null

The audience rules that gate which users see this tutorial.

createdAt

UTCDateTime !
Non-null

The date and time this entity was created.

id

GlobalId !
Non-null

A unique internal GlobalId for this entity.

name

String !
Non-null

The internal name of the tutorial, shown in the admin list.

status

TutorialStatus !
Non-null

The lifecycle status of the tutorial.

steps

[ TutorialStep !]!
Non-null

The ordered steps of the tutorial.

updatedAt

UTCDateTime !
Non-null

The date and time this entity was last updated.

Usages

#

References

#

  • Field activeTutorial from Query