Package io.writeopia.sdk.models.story
Class StoryStep
-
- All Implemented Interfaces:
public final class StoryStepThe model defining the information that can be draw in the screen. This is the most basic building block of the library and can have many types like image, message, audio, video, button, empty space, etc.
-
-
Field Summary
Fields Modifier and Type Field Description private final Integerkeyprivate final BooleanisGroupprivate final Stringidprivate final StringlocalIdprivate final StoryTypetypeprivate final StringparentIdprivate final Stringurlprivate final Stringpathprivate final Stringtextprivate final Booleancheckedprivate final List<StoryStep>stepsprivate final Decorationdecoration
-
Method Summary
Modifier and Type Method Description final IntegergetKey()final BooleanisGroup()final StringgetId()final StringgetLocalId()final StoryTypegetType()final StringgetParentId()final StringgetUrl()final StringgetPath()final StringgetText()final BooleangetChecked()final List<StoryStep>getSteps()final DecorationgetDecoration()final StoryStepcopyNewLocalId()-
-
Constructor Detail
-
StoryStep
StoryStep(String id, String localId, StoryType type, String parentId, String url, String path, String text, Boolean checked, List<StoryStep> steps, Decoration decoration)
- Parameters:
id- the ID of the story step.localId- This in a temporary ID that identifies the current drawing of the content of the StoryStep.type- StoryType The is the type that identifies the story step.parentId- The ID of a parent StoryStep, in case this StoryStep is inside a group.url- Used for fetch an image, video, audio or other type of content.path- Local path for content, like image, video, audio or other type of content.text- The text of the StoryStep.checked- If the type of this StorySteo is "check_item" or other type that can be checked this parameter holds the information if it is checked or not.steps- List<StoryType> a groups of StorySteps that can be inside the current StoryStep, if it is a group.decoration- Decoration The decoration fo the StoryStep.
-
-
Method Detail
-
getLocalId
final String getLocalId()
-
getParentId
final String getParentId()
-
getChecked
final Boolean getChecked()
-
getDecoration
final Decoration getDecoration()
-
copyNewLocalId
final StoryStep copyNewLocalId()
-
-
-
-