CoreMedia CKEditor 5 Plugins
    Preparing search index...

    Interface ContentFormService

    interface ContentFormService {
        canBeOpened(contentUriPath: string): Promise<boolean>;
        observe_activeContent(): Observable<unknown>;
        openContentForm(
            contentUriPath: string,
            options?: { additionalOptions?: Record<string, unknown>; focus?: boolean },
        ): Promise<{ accepted: string[]; rejected: string[] }>;
    }

    Implemented by

    Index

    Methods

    canBeOpened observe_activeContent openContentForm

    Methods

    • Opens entity given by their REST URI in Studio tab.

      Parameters

      • contentUriPath: string

        The content to open the form for, given as a valid Studio Rest content URI.

      • Optionaloptions: { additionalOptions?: Record<string, unknown>; focus?: boolean }
        • OptionaladditionalOptions?: Record<string, unknown>

          Additional but undetermined options that a service implementation might support but is not obliged to (for example, one implementation might support a 'background' option to open the form in the background but other implementations might not).

        • Optionalfocus?: boolean

          Whether the app that opens the form should be focused / brought into the foreground.

      Returns Promise<{ accepted: string[]; rejected: string[] }>

      A promise that resolves to true if the form was opened successfully, or false otherwise.

      • focus: whether the app in which this method is called shall be focused. This is 'true' by default.

    Settings

    Member Visibility

    On This Page

    Methods