Skip to main content

Interface: CommentaryProviderDescriptor

Defined in: Extensions/ExtensionApiDtos.ts:759

Properties

abbreviation

abbreviation: string

Defined in: Extensions/ExtensionApiDtos.ts:763


capabilities

capabilities: CommentaryCapability[]

Defined in: Extensions/ExtensionApiDtos.ts:766


fetchEndpoint

fetchEndpoint: string

Defined in: Extensions/ExtensionApiDtos.ts:768

RPC endpoint name the host calls to fetch a single entry.


id

id: string

Defined in: Extensions/ExtensionApiDtos.ts:761

Namespaced under the extension's ID.


iterateEndpoint?

optional iterateEndpoint?: string

Defined in: Extensions/ExtensionApiDtos.ts:772

Optional reverse-RPC endpoint for bulk iteration.


language?

optional language?: string

Defined in: Extensions/ExtensionApiDtos.ts:765

bcp47.


name

name: LocalizedString

Defined in: Extensions/ExtensionApiDtos.ts:762


rangeEndpoint?

optional rangeEndpoint?: string

Defined in: Extensions/ExtensionApiDtos.ts:770

Optional reverse-RPC endpoint for range fetch.


similarityEndpoint?

optional similarityEndpoint?: string

Defined in: Extensions/ExtensionApiDtos.ts:774

Optional: this provider can also serve "find similar" queries.