AboutSupportDeveloper GuideVersion 19.1.23

Interface MicrosoftEntityTypeConfig

Configuration object for the Microsoft 365 workflow integration.

Used for choosing which Microsoft 365 entities to include in the search results.

Example

const config: MicrosoftEntityTypeConfig = {
    message: true,
    chatMessage: true,
    drive: false,
    event: false,
    user: true,
    contact: false,
    list: false,
};

Hierarchy

  • MicrosoftEntityTypeConfig

Properties

chatMessage? contact? drive? event? list? message? user?

Properties

Optional chatMessage

chatMessage?: boolean

Whether or not to include messages (Teams Messages) in the search results.

'Chat.Read' OR 'Chat.ReadWrite' AND 'ChannelMessage.Read.All' OAuth scopes are required to access this data. If these scopes are not provided, user Authentication will fail.

Futhermore, the openUrlWithBrowser permission must be enabled in the application manifest. This should support the msteams protocols. This is used for opening the Teams client when action-ing a Teams message. See the Developer Guide for more information.

Default

true

Optional contact

contact?: boolean

Whether or not to include contacts (Outlook Contacts) in the search results.

'Contacts.Read.Shared' OAuth scopes are required to access this data. If these scopes are not provided, user Authentication will fail.

Default

true

Optional drive

drive?: boolean

Whether or not to include files (OneDrive Files) in the search results.

Default

true

Optional event

event?: boolean

Whether or not to include events (Outlook Calendar Events) in the search results.

'Calendars.Read' OR 'Calendars.ReadWrite' OAuth scopes are required to access this data. If these scopes are not provided, user Authentication will fail.

Default

true

Optional list

list?: boolean

Whether or not to include lists (SharePoint Lists) in the search results.

'Sites.Read.All' OR 'Sites.ReadWrite.All' AND 'Mail.ReadWrite.Shared' OAuth scope is required to access this data.

Default

true

Optional message

message?: boolean

Whether or not to include messages (Outlook Emails) in the search results.

'Mail.ReadWrite.Shared' OAuth scopes are required to access this data. If these scopes are not provided, user Authentication will fail.

Default

true

Optional user

user?: boolean

Whether or not to include users (People) in the search results.

'User.Read.All' AND 'Presence.Read.All' OAuth scopes are required to access this data. If these scopes are not provided, user Authentication will fail.

Default

true

Settings

Theme

On This Page