Interface RichtextConfigurationService

Provides access to configuration options for Richtext behavior within an application such as CoreMedia Studio.

The application is required providing an implementation for this interface to use plugins based on this configuration.

interface RichtextConfigurationService {
    hasLinkableType(uriPath): Promise<boolean>;
    isEmbeddableType(uriPath): Promise<boolean>;
    resolveBlobPropertyReference(uriPath): Promise<string>;
}

Implemented by

Index

Methods

hasLinkableType isEmbeddableType resolveBlobPropertyReference

Methods

hasLinkableType

hasLinkableType(uriPath): Promise<boolean>
Signals, if the entity described by the given URI path (typically a content) can be linked to from within Richtext.
Parameters
- uriPath: string
  URI path of the entity such as content/42
Returns Promise<boolean>
- Defined in packages/ckeditor5-coremedia-studio-integration/src/content/RichtextConfigurationService.ts:17

isEmbeddableType

isEmbeddableType(uriPath): Promise<boolean>
Signals, if the entity described by the given URI path (typically a content) can be embedded into Richtext. This typically applies to contents holding media blobs such as images.
Parameters
- uriPath: string
  URI path of the entity such as content/42
Returns Promise<boolean>
- Defined in packages/ckeditor5-coremedia-studio-integration/src/content/RichtextConfigurationService.ts:26

resolveBlobPropertyReference

resolveBlobPropertyReference(uriPath): Promise<string>
Resolves the URI-Path to a Blob-Property reference, which then may be used as xlink:href for <img> elements.

Producers have to transform the given URI-path like content/42 to some blob-property reference, such as content/42#properties.data. In general, the method is only called, when a content has previously been identified as being embeddable.
Parameters
- uriPath: string
  URI path of the entity such as content/42
Returns Promise<string>
- Defined in packages/ckeditor5-coremedia-studio-integration/src/content/RichtextConfigurationService.ts:39