Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Provides methods for interacting with M365 Copilot in model-driven Power Apps, including preview APIs for executing registered Microsoft Copilot Studio topics.
Methods
| Method | Description |
|---|---|
| addActionHandler | Registers a custom handler function for a Microsoft 365 Copilot action. |
| addDefaultActionHandlers | Restores the platform-default handlers for a Microsoft 365 Copilot action. |
| executeEvent | (preview) Executes a Microsoft Copilot Studio topic based on the registered Event Name. Returns an array of type MCSResponse. |
| executePrompt | (preview) Executes a Microsoft Copilot Studio topic based on the trigger queries registered in the topic. Returns the array of type MCSResponse. |
| getCurrentAgent | Returns the currently active Microsoft 365 Copilot agent, or undefined if the agent state is not yet known. |
| isM365CopilotEnabled | Returns whether Microsoft 365 Copilot is enabled in the current environment. |
| openM365CopilotPanel | Opens the Microsoft 365 Copilot side panel. |
| removeActionHandler | Removes a previously registered custom handler for a Microsoft 365 Copilot action. |
| removeDefaultActionHandlers | Removes the platform-default handlers for a Microsoft 365 Copilot action. |
| sendPromptToM365Copilot | Sends a prompt to the Microsoft 365 Copilot side panel, causing Copilot to process and respond on behalf of the user. |
| updateContext | (preview) Sends updated app context to the Microsoft 365 Copilot side panel. |
Interfaces
| Interface | Description |
|---|---|
| M365CopilotAgent | Describes the currently active Microsoft 365 Copilot agent — returned by getCurrentAgent. |
| M365CopilotAgentMode | Describes how a Microsoft 365 Copilot agent is being referenced. |
| MCSResponse | Describes the data returned by the executeEvent and executePrompt methods. |
| PowerAppsContent | Describes the context data passed to the updateContext method. All properties are optional. |
| SendPromptToM365CopilotOptions | Describes the optional parameters passed to the sendPromptToM365Copilot method. |