Class Microsoft365WorkflowIntegration

constructor

• new Microsoft365WorkflowIntegration(
      config: Microsoft365IntegrationConfig,
  ): Microsoft365WorkflowIntegration

  Creates an instance of Microsoft365WorkflowIntegration.

  Parameters

  • config: Microsoft365IntegrationConfig

    The configuration object for the integration.

  Returns Microsoft365WorkflowIntegration

  Example

  const microsoft365Integration = new Microsoft365WorkflowIntegration({
       connect: {
           clientId: microsoft365Config.clientId,       // Client ID of the registered app
           tenantId: microsoft365Config.tenantId,       // Tenant ID of the registered app
           redirectUri: microsoft365Config.redirectUri  // Redirect URI of the registered app. This _must_ be the same domain as the app (providerUrl).
       },
  });
  
  await WorkspacePlatform.init({
      browserOptions: {},
      integrations: [microsoft365Integration]
  
  Copy

config

workflowIntegrationName

_initializeWorkflows

• _initializeWorkflows(config?: WorkflowIntegrationConfig): Promise<void>

  Parameters

  • config: WorkflowIntegrationConfig = ...

  Returns Promise<void>

connect

• connect(config?: Microsoft365ConnectionConfig): Promise<void>

  Connects to the Microsoft 365 API using the provided configuration.

  Parameters

  • config: Microsoft365ConnectionConfig = ...

    Defaults to the config provided to the constructor, but can be overridden here.

  Returns Promise<void>

  Example

  await microsoft365Integration.connect({
      clientId: microsoft365Config.clientId,
      tenantId: microsoft365Config.tenantId,
      redirectUri: microsoft365Config.redirectUri
  });
  Copy

initializeWorkflow

• initializeWorkflow(workflow: string): Promise<void>

  Initializes a given workflow.

  This method is automatically called when disableAutoInitialize is set to false in the workflow configuration.

  Use this method if you need to call it manually (not at platform initialization).

  Parameters

  • workflow: string

    The workflow to initialize.

  Returns Promise<void>

  Example

  const microsoft365WorkflowIntegration = new Microsoft365WorkflowIntegration({
      connect: {
          clientId: microsoft365Config.clientId,
          tenantId: microsoft365Config.tenantId,
          redirectUri: microsoft365Config.redirectUri
      },
      workflows: {
          search: {
              disableAutoInitialize: true
          }
      }
  });
  
  await platformInit({
      overrideCallback,
      browserOptions: {},
      integrations: [microsoft365WorkflowIntegration]
  });
  
  await microsoft365WorkflowIntegration.initializeWorkflow('search');
  Copy