Interface NewStory

Metadata for a story created by AccountBase.addStory or AccountBase.ensureStory.

interface NewStory {
    accessLevel?: AccessLevel;
    content?: StoryElementUpdate[];
    displayName?: string;
    tags?: string[];
}

Hierarchy

Omit<StoryCreate, "name" | "content">
- NewStory

Index

Properties

accessLevel? content? displayName? tags?

Properties

`Optional`accessLevel

accessLevel?: AccessLevel

Who can reach the story — see AccessLevel.

`Optional`content

content?: StoryElementUpdate[]

The paragraphs and queries the story is made of, in order.

`Optional`displayName

displayName?: string

Title shown in the interface, free of the restrictions that apply to name.

`Optional`tags

tags?: string[]

Free-form labels, used for filtering and search.