addActionHandler (αναφορά API προγράμματος-πελάτη)

Καταχωρεί μια συνάρτηση προσαρμοσμένου προγράμματος χειρισμού για μια ενέργεια Microsoft 365 Copilot.

Σύνταξη

Xrm.Copilot.addActionHandler(actionId, actionHandler).then(successCallback, errorCallback);

Παράμετροι

Όνομα παραμέτρου Type Υποχρεωτικό Περιγραφή
actionId string Yes Το μοναδικό αναγνωριστικό της ενέργειας προς χειρισμό.
actionHandler Function Yes Η συνάρτηση που θα κληθεί όταν ενεργοποιείται η ενέργεια. Λαμβάνει το ωφέλιμο φορτίο δεδομένων της ενέργειας ως όρισμα.
successCallback Function Yes Μια συνάρτηση για κλήση όταν η λειτουργία είναι επιτυχής.
errorCallback Function Yes Μια λειτουργία για κλήση όταν αποτύχει η λειτουργία.

Τιμή επιστροφής

Τύπος: Promise<void>

Remarks

Μπορείτε να καταχωρήσετε πολλούς χειρισμούς για την ίδια actionId. Εκτελούνται διαδοχικά. Το API αγνοεί σιωπηλά την καταχώρηση της ίδιας αναφοράς συνάρτησης δύο φορές για την ίδια actionId. Το API δεν κάνει τίποτα εάν το Microsoft 365 Copilot δεν είναι ενεργοποιημένο.

Ενσωματωμένα αναγνωριστικά ενεργειών

Τα ακόλουθα αναγνωριστικά ενεργειών έχουν καταχωρημένους προεπιλεγμένους χειρισμούς πλατφόρμας. Μπορείτε να προσθέσετε προσαρμοσμένους χειρισμούς δίπλα τους ή να καταργήσετε πρώτα τους προεπιλεγμένους χειρισμούς χρησιμοποιώντας το removeDefaultActionHandlers.

Αναγνωριστικό ενέργειας Περιγραφή Ιδιότητες δεδομένων
MS.PA.CopilotChat.OpenRecord Ανοίγει μια εγγραφή. entity (συμβολοσειρά) — λογικό όνομα πίνακα recordId (συμβολοσειρά) — αναγνωριστικό εγγραφής
MS.PA.CopilotChat.NavigateToView Μεταβαίνει σε μια προβολή. entity (συμβολοσειρά) — λογικό όνομα πίνακα fetchXml (συμβολοσειρά) — Ερώτημα FetchXML

Παράδειγμα

const handler = async ({ entity, recordId }) => {
    // Open the record in a side pane instead of navigating away
    const pane = Xrm.App.sidePanes.createPane({ canClose: true });
    await pane.navigate({ pageType: "entityrecord", entityName: entity, entityId: recordId });
};

await Xrm.Copilot.addActionHandler("My.Namespace.MyActionMessage", handler);

μέθοδος removeActionHandler
Xrm.Copilot (αναφορά API προγράμματος-πελάτη)