Get-WebSocket-EndpunktGet websocket endpoint

Namespace: microsoft.graphNamespace: microsoft.graph

Ermöglicht das Empfangen von Änderungsbenachrichtigungen in unmittelbarer Echtzeit für ein [Laufwerk][] und eine [Liste][] mit Socket.IO.Allows you to receive near-real-time change notifications for a drive and list using socket.io. Socket.IO ist eine beliebte Benachrichtigungs Bibliothek für JavaScript, die websockets verwendet.Socket.io is a popular notifications library for JavaScript that utilizes WebSockets. Weitere Informationen finden Sie unter Socket.IO.To learn more, see socket.io.

BerechtigungenPermissions

Eine der nachfolgenden Berechtigungen ist erforderlich, um diese API aufrufen zu können. Weitere Informationen, unter anderem zur Auswahl von Berechtigungen, finden Sie im Artikel zum Thema Berechtigungen.One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

BerechtigungstypPermission type Berechtigungen (von der Berechtigung mit den wenigsten Rechten zu der mit den meisten Rechten)Permissions (from least to most privileged)
Delegiert (Geschäfts-, Schul- oder Unikonto)Delegated (work or school account) Files. Read, files. ReadWrite, files. ReadWrite. all, Sites. ReadWrite. allFiles.Read, Files.ReadWrite, Files.ReadWrite.All, Sites.ReadWrite.All
Delegiert (persönliches Microsoft-Konto)Delegated (personal Microsoft account) Files. Read, files. ReadWrite, files. ReadWrite. allFiles.Read, Files.ReadWrite, Files.ReadWrite.All
AnwendungApplication Nicht unterstütztNot supported.

HTTP-AnforderungHTTP request

GET /me/drive/root/subscriptions/socketIo
GET /drives/{driveId}/root/subscriptions/socketIo
GET /lists/{list-id}/subscriptions/socketIo
GET /groups/{groupId}/drive/root/subscriptions/socketIo
GET /sites/{siteId}/lists/{listId}/drive/root/subscriptions/socketIo

BeispielExample

AnforderungRequest

GET /me/drive/root/subscriptions/socketIo

AntwortResponse

Wenn die Methode erfolgreich verläuft, werden der 200 OK Antwortcode und ein Subscription -Objekt im Antworttext zurückgegeben.If successful, this method returns a 200 OK response code and a subscription object in the response body.

HTTP/1.1 200 OK
Content-type: application/json

{
  "id": "opaqueId-fj3hd7yf283jfk193726nvc2w3i2diemdu8",
  "notificationUrl": "https://f3hb0mpua.svc.ms/zbaehwg/callback?snthgk=1ff3-2345672zz831837523"
}

Das notificationUrl zurückgegebene ist eine Socket.IO-Endpunkt-URL.The notificationUrl returned is a socket.io endpoint URL.

Im folgenden Beispiel wird die Verwendung notificationUrl von mit Socket.IO in JavaScript veranschaulicht.The following example shows how to use the notificationUrl with socket.io in JavaScript.

// this is the notificationUrl returned from this API
var notificationUrl = "https://f3hb0mpua.svc.ms/zbaehwg/callback?snthgk=1ff3-2345672zz831837523";

// 'io' comes from the socket.io client library
var socket = io(notificationUrl);

// these examples log to the console.
// your app would provide its own callbacks
socket.on("connect", ()=>console.log("Connected!"));
socket.on("notification", (data)=>console.log("Notification!", data));