Class DraftStore

Public

Hierarchy (view full)

Implements

Constructors

constructor

Properties

draftState draftTags initEditionsCount isModalOpen loading publishDraft type

Accessors

draftId drafts isEnabled isLoading selectedDraft

Methods

createDraft deleteDraft disableDraft enableDraft getDraftOperation getSubjectId indexOf loadDraft loadDraftList loadInitialData removeCheckedDrafts removeDraft saveDraft setCurrentDraft setDraftAtIndex setDraftList setIsModalOpen setLoading startDraftMode

Constructors

constructor

Properties

draftState

draftState: DRAFT_STATE

ReadonlydraftTags

draftTags: DraftTags

ReadonlyinitEditionsCount

initEditionsCount: number

Draft for data (records or assets) initializes with initEditionsCount = 0, others draft initialize with initEditionsCount = 1. We use it to track changes when publishing

isModalOpen

isModalOpen: boolean

Protectedloading

loading: boolean

publishDraft

publishDraft: ((withForce: boolean, withDelete: boolean, payload?: Record<string, string>) => Promise<Draft>)

Readonlytype

type: keyof IDraftType

Accessors

draftId

  • get draftId(): number

  • Draft identifier

    Returns number

drafts

  • get drafts(): Draft[]

  • Returns Draft[]

isEnabled

  • get isEnabled(): boolean

  • Returns boolean

isLoading

  • get isLoading(): boolean

  • Returns boolean

selectedDraft

  • get selectedDraft(): undefined | Draft

  • Returns undefined | Draft

Methods

createDraft

  • createDraft(): Draft

  • Returns Draft

deleteDraft

  • deleteDraft(draft): Promise<void>

  • Parameters

    Returns Promise<void>

disableDraft

  • disableDraft(): void

  • Returns void

enableDraft

  • enableDraft(): void

  • Returns void

getDraftOperation

getSubjectId

  • getSubjectId(): string

  • Returns string

indexOf

  • indexOf(draft): number

  • Parameters

    Returns number

loadDraft

  • loadDraft(draftId): Promise<Draft>

  • Parameters

    • draftId: number

    Returns Promise<Draft>

loadDraftList

  • loadDraftList(): Promise<Draft[]>

  • Returns Promise<Draft[]>

loadInitialData

  • loadInitialData(): Promise<void>

  • Init draft store - get and set draftId from query

    Returns Promise<void>

removeCheckedDrafts

  • removeCheckedDrafts(indexes): Promise<Draft[]>

  • Parameters

    • indexes: number[]

    Returns Promise<Draft[]>

removeDraft

  • removeDraft(draft): void

  • Parameters

    Returns void

saveDraft

  • saveDraft(draft, hideMessage?): Promise<Draft>

  • Parameters

    • draft: Draft
    • OptionalhideMessage: boolean

    Returns Promise<Draft>

setCurrentDraft

  • setCurrentDraft(draft): void

  • Parameters

    Returns void

setDraftAtIndex

  • setDraftAtIndex(index, draft): void

  • Parameters

    • index: number
    • draft: Draft

    Returns void

setDraftList

  • setDraftList(draftList): void

  • Parameters

    Returns void

setIsModalOpen

  • setIsModalOpen(isOpen): void

  • Parameters

    • isOpen: boolean

    Returns void

setLoading

startDraftMode

  • startDraftMode(): Promise<void>

  • Start draft mode

    Returns Promise<void>

On This Page

Constructors
Properties
Accessors
Methods