Skip to content

Commit 8b30f76

Browse files
authored
Fix typo
1 parent 3a71aa8 commit 8b30f76

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

articles/azure-web-pubsub/socketio-serverless-function-binding.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ When deployed use the [application settings](../azure-functions/functions-how-to
5858

5959
| Configuration Name | Description|
6060
|---------|----------|
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|
6262
|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.|
6363
|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.|
6464

@@ -102,7 +102,7 @@ The attribute for input binding is `[SocketIONegotiation]`.
102102
|---------|---------|
103103
| Hub | The hub name that a client needs to connect to. |
104104
| 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. |
106106

107107
# [JavaScript Model v4](#tab/javascript-v4)
108108

@@ -140,7 +140,7 @@ app.http('negotiate', {
140140
| name | Variable name used in function code for input connection binding object |
141141
| hub | The hub name that a client needs to connect to. |
142142
| 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. |
144144

145145
---
146146

@@ -167,7 +167,7 @@ def negotiate(req: func.HttpRequest, negotiate) -> func.HttpResponse:
167167
| type | Must be `socketionegotiation` |
168168
| hub | The hub name that a client needs to connect to. |
169169
| 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. |
171171

172172
---
173173

@@ -242,7 +242,7 @@ The attribute for trigger binding is `[SocketIOTrigger]`.
242242

243243
#### SocketIOAttribute
244244

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:
246246

247247
```cs
248248
[FunctionName("SocketIOTriggerMessage")]
@@ -262,7 +262,7 @@ public static async Task NewMessage(
262262
}
263263
```
264264

265-
Note that `ParameterNames` and `[SocketIOParameter]` cannot be used together.
265+
Note that `ParameterNames` and `[SocketIOParameter]` can't be used together.
266266

267267
# [JavaScript Model v4](#tab/javascript-v4)
268268

@@ -461,9 +461,9 @@ The data structure of input binding arguments varies depending on the message ty
461461

462462
| Property | Description |
463463
|---------|---------|
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. |
467467
| 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. |
468468
| 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. |
469469
| 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
479479

480480
| Property | Description |
481481
|---------|---------|
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. |
484484

485485
#### Disconnected
486486

@@ -494,8 +494,8 @@ The data structure of input binding arguments varies depending on the message ty
494494

495495
| Property | Description |
496496
|---------|---------|
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. |
499499
| reason | The connection close reason description. |
500500

501501
#### Normal events
@@ -512,11 +512,11 @@ The data structure of input binding arguments varies depending on the message ty
512512

513513
| Property | Description |
514514
|---------|---------|
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. |
517517
| payload | The message payload in Engine.IO protocol |
518518
| eventName | The event name of the request. |
519-
| parameters | List of parameters of the message emittion. |
519+
| parameters | List of parameters of the message. |
520520

521521
## Output Binding
522522

0 commit comments

Comments
 (0)