Κοινοποίηση μέσω

executeEvent (αναφορά API προγράμματος-πελάτη) (προεπισκόπηση)

Σημαντικό

  • Αυτή είναι μια δυνατότητα προεπισκόπησης.
  • Οι δυνατότητες προεπισκόπησης δεν προορίζονται για χρήση στην παραγωγή και μπορεί να έχουν περιορισμένη λειτουργικότητα. Αυτές οι δυνατότητες υπόκεινται σε συμπληρωματικούς όρους χρήσης και διατίθενται πριν από μια επίσημη κυκλοφορία, έτσι ώστε οι πελάτες να μπορούν να αποκτήσουν πρώιμη πρόσβαση και να παρέχουν σχόλια.

Εκτελεί ένα θέμα microsoft Copilot Studio με βάση το καταχωρημένο όνομα συμβάντος. Επιστρέφει έναν πίνακα τύπου MCSResponse.

Σύνταξη

Xrm.Copilot.executeEvent(eventName, eventParameters).then(successCallback, errorCallback);

Παράμετροι

Όνομα παραμέτρου Δακτυλογραφώ Απαραίτητο Περιγραφή
eventName string Όχι Όνομα συμβάντος που έχει καταχωρηθεί στο θέμα Microsoft Copilot Studio
eventParameters Άγνωστος Όχι Παράμετροι που απαιτούνται για την εκτέλεση του συμβάντος. Αυτά εξαρτώνται από το τι κάνει το θέμα.
successCallback Function Όχι Μια συνάρτηση για κλήση όταν η λειτουργία είναι επιτυχής.
errorCallback Function Όχι Μια λειτουργία για κλήση όταν αποτύχει η λειτουργία.

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

Ένας πίνακας MCSResponse

Πρόσβαση σε περιβάλλον εφαρμογής

Όταν καλείται ένα API παράγοντα, το περιβάλλον για την εφαρμογή μεταβιβάζεται στο θέμα Copilot Studio μέσω ενός συνόλου μεταβλητών. Ακολουθούν μεταβλητές περιβάλλοντος που είναι διαθέσιμες ως Copilot Studio καθολικές μεταβλητές.

Μεταβλητή Περιγραφή
Global.PA__Copilot_Model_PageContext.pageContext.id.guid Αναγνωριστικό της εγγραφής πίνακα στην κύρια φόρμα
Global.PA__Copilot_Model_PageContext.pageContext.entityTypeName Λογικό όνομα του πίνακα στην κύρια σελίδα
Global.PA__Copilot_Model_PageContext.pageContext.pageName Όνομα της κύριας σελίδας
Global.PA__Copilot_Model_PageContext.pageContext.pageType Τύπος κύριας σελίδας
Global.PA__Copilot_Model_AppUniqueNameContext.appUniqueNameContext.appUniqueName Μοναδικό όνομα της εφαρμογής που καθοδηγείται από μοντέλο

Για παράδειγμα, η χρήση Global.PA__Copilot_Model_PageContext.pageContext.id.guid και Global.PA__Copilot_Model_PageContext.pageContext.entityTypeName, της εγγραφής της φόρμας μπορεί να ανακτηθεί από το Dataverse.

Πρόσβαση σε συμβάνταΠαράμετροι

Στο θέμα Copilot Studio, η eventParameters πρόσβαση από την κλήση API είναι δυνατή χρησιμοποιώντας τη μεταβλητή Activity.Value. Χρησιμοποιήστε τον κόμβο τιμών ανάλυσης για να μετατρέψετε το JSON σε μια εγγραφή με ένα ή περισσότερα πεδία. Η επιλογή Από δείγμα δεδομένων για τον Τύπο δεδομένων επιτρέπει την παροχή ενός παραδείγματος JSON για τη δημιουργία της εγγραφής.

Παράδειγμα

Στο Microsoft Copilot Studio, όπου έχει καταχωρηθεί ένα θέμα που αποδέχεται ένα αναγνωριστικό (αναγνωριστικό εγγραφής οντότητας) ως παράμετρο εισόδου. Με βάση τα δεδομένα εισόδου, ανακτά τις σχετικές δραστηριότητες αυτής της εγγραφής οντότητας και επιστρέφει τα αποτελέσματα ως δραστηριότητα συμβάντων Copilot Studio.

const response = await Xrm.Copilot.executeEvent( 
    "Microsoft.PowerApps.Copilot.RelatedActivities", 
    { id:"aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"});

Απάντηση

[
    {
        "type": "event",
        "timestamp": "2025-02-05T16:05:53.4074714+00:00",
        "replyToId": "bbbbbbbb-1111-2222-3333-cccccccccccc",
        "attachments": [],
        "value": {
            "@odata.context": "https://*.dynamics.com/api/data/v9.2/$metadata#activitypointers(subject,prioritycode)",
            "value": [
                {
                    "@odata.etag": "W/\"6825587\"",
                    "@odata.type": "#Microsoft.Dynamics.CRM.phonecall",
                    "activityid": "cccccccc-2222-3333-4444-dddddddddddd",
                    "activitytypecode": "phonecall",
                    "prioritycode": 2,
                    "subject": "Discuss new opportunity (sample)"
                },
                {
                    "@odata.etag": "W/\"6826236\"",
                    "@odata.type": "#Microsoft.Dynamics.CRM.phonecall",
                    "activityid": "dddddddd-3333-4444-5555-eeeeeeeeeeee",
                    "activitytypecode": "phonecall",
                    "prioritycode": 2,
                    "subject": "Likes our new products (sample)"
                }
            ]
        },
        "name": "MS.CopilotApiDemo.RelatedActivities"
    }
]

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

  • Last updated on