Interface ComposerSuggestionRequest

Request passed to ComposerTriggerProvider.GetSuggestions each time the user types after an active trigger character.

interface ComposerSuggestionRequest {
    ContextUser: UserInfo | null;
    MaxResults: number;
    Provider: IMetadataProvider | null;
    Query: string;
}

Properties

ContextUser: UserInfo | null

The current user, when the host supplied one. Providers should fail closed (return []) if they require a user and none is present.

MaxResults: number

Maximum number of suggestions the editor will display; providers should honor it.

The metadata provider scoping this editor instance, when the host supplied one (multi-provider support).

Query: string

The text typed after the trigger character (may be empty — show the full list).