Optional
disableIf false, will automatically initialize the workflow when the Workspace Platform is initialized. Else, will need to be initialized by calling initializeWorkflow.
false
Optional
disabledIf true, will disable this workflow.
false
Optional
homeConfiguration object for the HomeProvider.
Use this to configure the HomeProvider for example, adding a custom logo or name.
See HomeProvider for configuration options.
Optional
clientAPIVersion?: stringversion of client SDK, set by the API
Optional
commandA keycode that can be used to interact with this Search Provider.
Optional
description?: stringA short description of the Search Provider.
Optional
dispatchIf set, focusing on a search result will trigger onResultDispatch callback.
Optional
hidden?: booleanA flag to indicate this provider will not be displayed as a command.
Optional
icon?: stringAn icon that a UI can display for the Search Provider.
Optional
id?: stringA unique ID used to identify the search provider.
Optional
identity?: { uuid?: string; name?: string; }The OpenFin identity that registered this search provider.
Optional
inputThe placeholder string to be displayed in a UI when targeting this specific Search Provider.
Optional
listA title to display above the result list in a UI when targeting this specific Search Provider.
Optional
logoLogo to show render when targeting this specific Search Provider.
Optional
Experimental
scoreThe order to sort the score in. The default is ascending
.
Optional
title?: stringA UI friendly title for the search provider.
Optional
microsoftConfiguration 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.
Optional
useThe 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.
true
Configuration object for the Microsoft 365 Search workflow integration.
All properties are optional. If they are omitted, the default values will be used.