You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/azure-web-pubsub/socketio-serverless-function-binding.md
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -58,7 +58,7 @@ When deployed use the [application settings](../azure-functions/functions-how-to
58
58
59
59
| Configuration Name | Description|
60
60
|---------|----------|
61
-
|WebPubSubForSocketIOConnectionString__endpoint| Required. The Endpoint of the service. E.g., https://mysocketio.webpubsub.azure.com|
61
+
|WebPubSubForSocketIOConnectionString__endpoint| Required. The Endpoint of the service. For example, https://mysocketio.webpubsub.azure.com|
62
62
|WebPubSubForSocketIOConnectionString__credential | Defines how a token should be obtained for the connection. This setting should be set to `managedidentity` if your deployed Azure Function intends to use managed identity authentication. This value is only valid when a managed identity is available in the hosting environment.|
63
63
|WebPubSubForSocketIOConnectionString__clientId | When `credential` is set to `managedidentity`, this property can be set to specify the user-assigned identity to be used when obtaining a token. The property accepts a client ID corresponding to a user-assigned identity assigned to the application. If not specified, the system-assigned identity is used.|
64
64
@@ -102,7 +102,7 @@ The attribute for input binding is `[SocketIONegotiation]`.
102
102
|---------|---------|
103
103
| Hub | The hub name that a client needs to connect to. |
104
104
| Connection | The name of the app setting that contains the Socket.IO connection string (defaults to `WebPubSubForSocketIOConnectionString`). |
105
-
| UserId | The userId of the connection. It applys to all sockets in the connection. It becomes the `sub` claim in the generated token. |
105
+
| UserId | The userId of the connection. It applies to all sockets in the connection. It becomes the `sub` claim in the generated token. |
106
106
107
107
# [JavaScript Model v4](#tab/javascript-v4)
108
108
@@ -140,7 +140,7 @@ app.http('negotiate', {
140
140
| name | Variable name used in function code for input connection binding object |
141
141
| hub | The hub name that a client needs to connect to. |
142
142
| connection | The name of the app setting that contains the Socket.IO connection string (defaults to `WebPubSubForSocketIOConnectionString`). |
143
-
| userId | The userId of the connection. It applys to all sockets in the connection. It becomes the `sub` claim in the generated token. |
143
+
| userId | The userId of the connection. It applies to all sockets in the connection. It becomes the `sub` claim in the generated token. |
| hub | The hub name that a client needs to connect to. |
169
169
| connection | The name of the app setting that contains the Socket.IO connection string (defaults to `WebPubSubForSocketIOConnectionString`). |
170
-
| userId | The userId of the connection. It applys to all sockets in the connection. It becomes the `sub` claim in the generated token. |
170
+
| userId | The userId of the connection. It applies to all sockets in the connection. It becomes the `sub` claim in the generated token. |
171
171
172
172
---
173
173
@@ -242,7 +242,7 @@ The attribute for trigger binding is `[SocketIOTrigger]`.
242
242
243
243
#### SocketIOAttribute
244
244
245
-
`SocketIOAttribute` is an alternative of `ParameterNames`, which simplify the function definition. For example, the following two definitions have the same effection:
245
+
`SocketIOAttribute` is an alternative of `ParameterNames`, which simplifies the function definition. For example, the following two definitions have the same effection:
246
246
247
247
```cs
248
248
[FunctionName("SocketIOTriggerMessage")]
@@ -262,7 +262,7 @@ public static async Task NewMessage(
262
262
}
263
263
```
264
264
265
-
Note that `ParameterNames` and `[SocketIOParameter]`cannot be used together.
265
+
Note that `ParameterNames` and `[SocketIOParameter]`can't be used together.
266
266
267
267
# [JavaScript Model v4](#tab/javascript-v4)
268
268
@@ -461,9 +461,9 @@ The data structure of input binding arguments varies depending on the message ty
461
461
462
462
| Property | Description |
463
463
|---------|---------|
464
-
| namespace | The namespace of the soceket. |
465
-
| socketId | The unique identity of the soceket. |
466
-
| claims | The claim of jwt of the client connection. Note, it's not the jwt when the service request the function, but the jwt when the Engine.IO client connects to the service. |
464
+
| namespace | The namespace of the socket. |
465
+
| socketId | The unique identity of the socket. |
466
+
| claims | The claim of JWT of the client connection. Note, it's not the JWT when the service request the function, but the JWT when the Engine.IO client connects to the service. |
467
467
| query | The query of the client connection. Note, it's not the query when the service request the function, but the query when the Engine.IO client connects to the service. |
468
468
| headers | The headers of the client connection. Note, it's not the headers when the service request the function, but the headers when the Engine.IO client connects to the service. |
469
469
| clientCertificates | The client certificate if it's enabled |
@@ -479,8 +479,8 @@ The data structure of input binding arguments varies depending on the message ty
479
479
480
480
| Property | Description |
481
481
|---------|---------|
482
-
| namespace | The namespace of the soceket. |
483
-
| socketId | The unique identity of the soceket. |
482
+
| namespace | The namespace of the socket. |
483
+
| socketId | The unique identity of the socket. |
484
484
485
485
#### Disconnected
486
486
@@ -494,8 +494,8 @@ The data structure of input binding arguments varies depending on the message ty
494
494
495
495
| Property | Description |
496
496
|---------|---------|
497
-
| namespace | The namespace of the soceket. |
498
-
| socketId | The unique identity of the soceket. |
497
+
| namespace | The namespace of the socket. |
498
+
| socketId | The unique identity of the socket. |
499
499
| reason | The connection close reason description. |
500
500
501
501
#### Normal events
@@ -512,11 +512,11 @@ The data structure of input binding arguments varies depending on the message ty
512
512
513
513
| Property | Description |
514
514
|---------|---------|
515
-
| namespace | The namespace of the soceket. |
516
-
| socketId | The unique identity of the soceket. |
515
+
| namespace | The namespace of the socket. |
516
+
| socketId | The unique identity of the socket. |
517
517
| payload | The message payload in Engine.IO protocol |
518
518
| eventName | The event name of the request. |
519
-
| parameters | List of parameters of the message emittion. |
519
+
| parameters | List of parameters of the message. |
0 commit comments