Skip to content

Commit b664b7d

Browse files
committed
refine selfAddr
1 parent e349a5f commit b664b7d

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

src-docs/spec/selfAddr_and_selfName.md

+13-12
Original file line numberDiff line numberDiff line change
@@ -6,27 +6,28 @@
66
window.webxdc.selfAddr
77
```
88

9-
A unique string for addressing the user of a running webxdc application.
10-
The address must be
9+
`selfAddr` is a unique string within a webxdc application that
1110

12-
- identical across multiple invocations of the same webxdc application,
11+
- can be used in other webxdc APIs,
1312

14-
- identical on multiple devices of the user,
13+
- should not be shown in the user interface of the webxdc app,
1514

16-
- must be distinct from other user's addresses participating in the webxdc application.
15+
- is identical across multiple invocations of the same webxdc application,
1716

18-
The address should not be shown in the user interface of the webxdc app
19-
except for debugging purposes because it is not guaranteed to be human-readable,
20-
may be long, and may not have any meaning outside the context of the webxdc application.
17+
- is identical on multiple devices of the user using the same webxdc application,
2118

22-
A webxdc application can
19+
- is not guaranteed to be human-readable,
2320

24-
- send its `selfAddr` value around in the payload passed to [`sendUpdate()`] and
21+
- should not have meaning outside the webxdc application.
22+
23+
For example, a webxdc application can
24+
25+
- send its `selfAddr` value as part of the `payload` passed into [`sendUpdate()`],
2526

2627
- receive such addresses through the payload of incoming updates,
2728

2829
- put such addresses into the `notify` parameter passed to [`sendUpdate()`]
29-
to cause a user-interface notification for the users behind the addresses.
30+
to cause a user-interface notification for respective users.
3031

3132

3233
## selfName
@@ -36,6 +37,6 @@ window.webxdc.selfName
3637
```
3738

3839
This is the nick or display name for the webxdc user
39-
which is intended for showing it in the user interface.
40+
which can be displayed in the user interface for human recognition.
4041

4142
[`sendUpdate()`]: ./sendUpdate.html

0 commit comments

Comments
 (0)