AboutSupportDeveloper GuideVersion 22.3.18

Interface MicrosoftSearchWorkflowConfig

Configuration object for the Microsoft 365 Search workflow integration.

All properties are optional. If they are omitted, the default values will be used.

interface MicrosoftSearchWorkflowConfig {
    disableAutoInitialize?: boolean;
    disabled?: boolean;
    homeProvider?: {
        clientAPIVersion?: string;
        commandCode?: string;
        description?: string;
        dispatchFocusEvents?: boolean;
        hidden?: boolean;
        icon?: string;
        id?: string;
        identity?: {
            name?: string;
            uuid?: string;
        };
        inputLandingPlaceholder?: string;
        inputPlaceholder?: string;
        listTitle?: string;
        logoUrl?: string;
        scoreOrder?: ScoreOrder;
        title?: string;
    };
    microsoftEntityTypeConfig?: MicrosoftEntityTypeConfig;
    useTeamsDeepLink?: boolean;
}

Hierarchy

  • WorkflowConfig
    • MicrosoftSearchWorkflowConfig

Properties

disableAutoInitialize? disabled? homeProvider? microsoftEntityTypeConfig? useTeamsDeepLink?

Properties

OptionaldisableAutoInitialize

disableAutoInitialize?: boolean

If false, will automatically initialize the workflow when the Workspace Platform is initialized. Else, will need to be initialized by calling initializeWorkflow.

Default

false

Optionaldisabled

disabled?: boolean

If true, will disable this workflow.

Default

false

OptionalhomeProvider

homeProvider?: {
    clientAPIVersion?: string;
    commandCode?: string;
    description?: string;
    dispatchFocusEvents?: boolean;
    hidden?: boolean;
    icon?: string;
    id?: string;
    identity?: {
        name?: string;
        uuid?: string;
    };
    inputLandingPlaceholder?: string;
    inputPlaceholder?: string;
    listTitle?: string;
    logoUrl?: string;
    scoreOrder?: ScoreOrder;
    title?: string;
}

Configuration object for the HomeProvider.

Use this to configure the HomeProvider for example, adding a custom logo or name.

See HomeProvider for configuration options.

Type declaration

  • OptionalclientAPIVersion?: string

    version of client SDK, set by the API

  • OptionalcommandCode?: string

    A keycode that can be used to interact with this Search Provider.

  • Optionaldescription?: string

    A short description of the Search Provider.

  • OptionaldispatchFocusEvents?: boolean

    If set, focusing on a search result will trigger onResultDispatch callback.

  • Optionalhidden?: boolean

    A flag to indicate this provider will not be displayed as a command.

  • Optionalicon?: string

    An icon that a UI can display for the Search Provider.

  • Optionalid?: string

    A unique ID used to identify the search provider.

  • Optionalidentity?: {
        name?: string;
        uuid?: string;
    }

    The OpenFin identity that registered this search provider.

    • Optionalname?: string

      The name of the component. Must be unique within the owning application.

    • Optionaluuid?: string

      Universally unique identifier of the application that owns the component.

  • OptionalinputLandingPlaceholder?: string

    A placeholder text that would be put into the empty search field for the selected provider for home in landing mode.

  • OptionalinputPlaceholder?: string

    The placeholder string to be displayed in a UI when targeting this specific Search Provider.

  • OptionallistTitle?: string

    A title to display above the result list in a UI when targeting this specific Search Provider.

  • OptionallogoUrl?: string

    Logo to show render when targeting this specific Search Provider.

  • Optional ExperimentalscoreOrder?: ScoreOrder

    The order to sort the score in. The default is ascending.

  • Optionaltitle?: string

    A UI friendly title for the search provider.

OptionalmicrosoftEntityTypeConfig

microsoftEntityTypeConfig?: MicrosoftEntityTypeConfig

Configuration object for the Microsoft 365 entity types to include in the search results.

Use this to enable/disable the different Microsoft 365 entity types.

See MicrosoftEntityTypeConfig for configuration options.

OptionaluseTeamsDeepLink

useTeamsDeepLink?: boolean

The msteams:// deep link can be used to open a Microsoft Teams chat in the Microsoft Teams desktop application.

This requires that the user has the Microsoft Teams desktop application installed. Else the call will silently fail.

Default

true

Settings

On This Page

Properties