CoreMedia CKEditor 5 Plugins
    Preparing search index...

    Interface CollectionViewLinkService

    Studio App service to open a collection view in a specific state.

    Use createCollectionViewLinkServiceDescriptor to create a service descriptor for registering and retrieving services of this type with the ServiceAgent.

    interface CollectionViewLinkService {
        openSearchResult(
            searchState: LinkSearchState,
            options?: { additionalOptions?: Record<string, unknown>; focus?: boolean },
        ): Promise<boolean>;
        showContentInCollectionView(
            content: string,
            options?: { additionalOptions?: Record<string, unknown>; focus?: boolean },
        ): Promise<boolean>;
    }
    Index

    Methods

    openSearchResult showContentInCollectionView

    Methods

    • Open a search result in the collection view, given an unknown/unused searchState

      Parameters

      • searchState: LinkSearchState

        the search state.

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

        Additional options.

        • 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 'view' option to open the content in one specific view or another but other implementations might not).

        • Optionalfocus?: boolean

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

      Returns Promise<boolean>

      A promise indicating success or failure opening the search result.

    • Shows a content in the collection view.

      The content must be given via a valid Studio Rest content URI and thus must comply to:

      ContentImpl#REST_RESOURCE_URI_TEMPLATE

      Additional options can be passed to determine how the content should be shown.

      Parameters

      • content: string

        The content to show in the collection view, given as a valid Studio Rest content URI.

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

        Additional options.

        • 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 'view' option to open the content in one specific view or another but other implementations might not).

        • Optionalfocus?: boolean

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

      Returns Promise<boolean>

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

    Settings

    Member Visibility

    On This Page

    Methods