@genesislcap/foundation-user 14.302.0 → 14.302.1-alpha-945e484.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/dts/tsdoc-metadata.json +1 -1
- package/dist/foundation-user.api.json +1 -1
- package/docs/api/foundation-user.defaultuser.addauthenticationchangelistener.md +33 -3
- package/docs/api/foundation-user.defaultuser.haspermission.md +33 -3
- package/docs/api/foundation-user.defaultuser.hasprofile.md +33 -3
- package/docs/api/foundation-user.defaultuser.md +493 -33
- package/docs/api/foundation-user.defaultuser.set.md +33 -3
- package/docs/api/foundation-user.defaultuser.trackaction.md +31 -3
- package/docs/api/foundation-user.legacyuserapi.md +100 -8
- package/docs/api/foundation-user.md +283 -31
- package/docs/api/foundation-user.setuserproperties.md +136 -8
- package/docs/api/foundation-user.user.addauthenticationchangelistener.md +33 -3
- package/docs/api/foundation-user.user.haspermission.md +33 -3
- package/docs/api/foundation-user.user.hasprofile.md +33 -3
- package/docs/api/foundation-user.user.md +279 -21
- package/docs/api/foundation-user.user.set.md +33 -3
- package/docs/api/foundation-user.useractionhistory.md +86 -8
- package/docs/api/foundation-user.useractionhistory.trackaction.md +31 -3
- package/docs/api/foundation-user.userconfig.md +98 -8
- package/docs/api/foundation-user.userconfig.setuser.md +45 -4
- package/docs/api/foundation-user.userconfig.unsetuser.md +31 -3
- package/docs/api/foundation-user.userdetailsproductproperty.md +60 -4
- package/docs/api/foundation-user.userdetailsproperty.md +155 -9
- package/docs/api/foundation-user.userdetailssystemproperty.md +41 -3
- package/docs/api/foundation-user.userpathhistory.md +88 -8
- package/docs/api/foundation-user.userqueueproperties.md +98 -6
- package/docs/api/index.md +21 -3
- package/docs/api-report.md.api.md +316 -0
- package/package.json +12 -12
|
@@ -14,9 +14,37 @@ unsetUser(user: WriteableUser): User;
|
|
|
14
14
|
|
|
15
15
|
## Parameters
|
|
16
16
|
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
17
|
+
<table><thead><tr><th>
|
|
18
|
+
|
|
19
|
+
Parameter
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
</th><th>
|
|
23
|
+
|
|
24
|
+
Type
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
</th><th>
|
|
28
|
+
|
|
29
|
+
Description
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
</th></tr></thead>
|
|
33
|
+
<tbody><tr><td>
|
|
34
|
+
|
|
35
|
+
user
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
</td><td>
|
|
39
|
+
|
|
40
|
+
WriteableUser
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
</td><td>
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
</td></tr>
|
|
47
|
+
</tbody></table>
|
|
20
48
|
|
|
21
49
|
**Returns:**
|
|
22
50
|
|
|
@@ -13,8 +13,64 @@ export interface UserDetailsProductProperty
|
|
|
13
13
|
|
|
14
14
|
## Properties
|
|
15
15
|
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
16
|
+
<table><thead><tr><th>
|
|
17
|
+
|
|
18
|
+
Property
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
</th><th>
|
|
22
|
+
|
|
23
|
+
Modifiers
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
</th><th>
|
|
27
|
+
|
|
28
|
+
Type
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
</th><th>
|
|
32
|
+
|
|
33
|
+
Description
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
</th></tr></thead>
|
|
37
|
+
<tbody><tr><td>
|
|
38
|
+
|
|
39
|
+
[name](./foundation-user.userdetailsproductproperty.name.md)
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
</td><td>
|
|
43
|
+
|
|
44
|
+
`readonly`
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
</td><td>
|
|
48
|
+
|
|
49
|
+
string
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
</td><td>
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
</td></tr>
|
|
56
|
+
<tr><td>
|
|
57
|
+
|
|
58
|
+
[version](./foundation-user.userdetailsproductproperty.version.md)
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
</td><td>
|
|
62
|
+
|
|
63
|
+
`readonly`
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</td><td>
|
|
67
|
+
|
|
68
|
+
string
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
</td><td>
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
</td></tr>
|
|
75
|
+
</tbody></table>
|
|
20
76
|
|
|
@@ -13,13 +13,159 @@ export interface UserDetailsProperty
|
|
|
13
13
|
|
|
14
14
|
## Properties
|
|
15
15
|
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
16
|
+
<table><thead><tr><th>
|
|
17
|
+
|
|
18
|
+
Property
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
</th><th>
|
|
22
|
+
|
|
23
|
+
Modifiers
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
</th><th>
|
|
27
|
+
|
|
28
|
+
Type
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
</th><th>
|
|
32
|
+
|
|
33
|
+
Description
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
</th></tr></thead>
|
|
37
|
+
<tbody><tr><td>
|
|
38
|
+
|
|
39
|
+
[daysToPasswordExpiry](./foundation-user.userdetailsproperty.daystopasswordexpiry.md)
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
</td><td>
|
|
43
|
+
|
|
44
|
+
`readonly`
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
</td><td>
|
|
48
|
+
|
|
49
|
+
number
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
</td><td>
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
</td></tr>
|
|
56
|
+
<tr><td>
|
|
57
|
+
|
|
58
|
+
[failedLoginAttempts](./foundation-user.userdetailsproperty.failedloginattempts.md)
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
</td><td>
|
|
62
|
+
|
|
63
|
+
`readonly`
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</td><td>
|
|
67
|
+
|
|
68
|
+
number
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
</td><td>
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
</td></tr>
|
|
75
|
+
<tr><td>
|
|
76
|
+
|
|
77
|
+
[heartbeatIntervalSecs](./foundation-user.userdetailsproperty.heartbeatintervalsecs.md)
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
</td><td>
|
|
81
|
+
|
|
82
|
+
`readonly`
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
</td><td>
|
|
86
|
+
|
|
87
|
+
number
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
</td><td>
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
</td></tr>
|
|
94
|
+
<tr><td>
|
|
95
|
+
|
|
96
|
+
[lastLoginDatetime](./foundation-user.userdetailsproperty.lastlogindatetime.md)
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
</td><td>
|
|
100
|
+
|
|
101
|
+
`readonly`
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
</td><td>
|
|
105
|
+
|
|
106
|
+
number
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
</td><td>
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
</td></tr>
|
|
113
|
+
<tr><td>
|
|
114
|
+
|
|
115
|
+
[product](./foundation-user.userdetailsproperty.product.md)
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
</td><td>
|
|
119
|
+
|
|
120
|
+
`readonly`
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
</td><td>
|
|
124
|
+
|
|
125
|
+
[UserDetailsProductProperty](./foundation-user.userdetailsproductproperty.md)<!-- -->\[\]
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
</td><td>
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
</td></tr>
|
|
132
|
+
<tr><td>
|
|
133
|
+
|
|
134
|
+
[rejectedLoginAttempts](./foundation-user.userdetailsproperty.rejectedloginattempts.md)
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
</td><td>
|
|
138
|
+
|
|
139
|
+
`readonly`
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
</td><td>
|
|
143
|
+
|
|
144
|
+
number
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
</td><td>
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
</td></tr>
|
|
151
|
+
<tr><td>
|
|
152
|
+
|
|
153
|
+
[system](./foundation-user.userdetailsproperty.system.md)
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
</td><td>
|
|
157
|
+
|
|
158
|
+
`readonly`
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
</td><td>
|
|
162
|
+
|
|
163
|
+
[UserDetailsSystemProperty](./foundation-user.userdetailssystemproperty.md)
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
</td><td>
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
</td></tr>
|
|
170
|
+
</tbody></table>
|
|
25
171
|
|
|
@@ -13,7 +13,45 @@ export interface UserDetailsSystemProperty
|
|
|
13
13
|
|
|
14
14
|
## Properties
|
|
15
15
|
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
16
|
+
<table><thead><tr><th>
|
|
17
|
+
|
|
18
|
+
Property
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
</th><th>
|
|
22
|
+
|
|
23
|
+
Modifiers
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
</th><th>
|
|
27
|
+
|
|
28
|
+
Type
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
</th><th>
|
|
32
|
+
|
|
33
|
+
Description
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
</th></tr></thead>
|
|
37
|
+
<tbody><tr><td>
|
|
38
|
+
|
|
39
|
+
[date](./foundation-user.userdetailssystemproperty.date.md)
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
</td><td>
|
|
43
|
+
|
|
44
|
+
`readonly`
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
</td><td>
|
|
48
|
+
|
|
49
|
+
string
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
</td><td>
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
</td></tr>
|
|
56
|
+
</tbody></table>
|
|
19
57
|
|
|
@@ -18,15 +18,95 @@ APIs to track a user's path history. Includes the pathname, search and hash only
|
|
|
18
18
|
|
|
19
19
|
## Properties
|
|
20
20
|
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
21
|
+
<table><thead><tr><th>
|
|
22
|
+
|
|
23
|
+
Property
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
</th><th>
|
|
27
|
+
|
|
28
|
+
Modifiers
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
</th><th>
|
|
32
|
+
|
|
33
|
+
Type
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
</th><th>
|
|
37
|
+
|
|
38
|
+
Description
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
</th></tr></thead>
|
|
42
|
+
<tbody><tr><td>
|
|
43
|
+
|
|
44
|
+
[pathHistory](./foundation-user.userpathhistory.pathhistory.md)
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
</td><td>
|
|
48
|
+
|
|
49
|
+
`readonly`
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
</td><td>
|
|
53
|
+
|
|
54
|
+
string\[\]
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
</td><td>
|
|
58
|
+
|
|
59
|
+
Array of paths that have been tracked.
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
</td></tr>
|
|
63
|
+
</tbody></table>
|
|
24
64
|
|
|
25
65
|
## Methods
|
|
26
66
|
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
67
|
+
<table><thead><tr><th>
|
|
68
|
+
|
|
69
|
+
Method
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
</th><th>
|
|
73
|
+
|
|
74
|
+
Description
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
</th></tr></thead>
|
|
78
|
+
<tbody><tr><td>
|
|
79
|
+
|
|
80
|
+
[clearPaths()](./foundation-user.userpathhistory.clearpaths.md)
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
</td><td>
|
|
84
|
+
|
|
85
|
+
Clears path history.
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
</td></tr>
|
|
89
|
+
<tr><td>
|
|
90
|
+
|
|
91
|
+
[lastPath()](./foundation-user.userpathhistory.lastpath.md)
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
</td><td>
|
|
95
|
+
|
|
96
|
+
May be used to return to a target path after authentication.
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
</td></tr>
|
|
100
|
+
<tr><td>
|
|
101
|
+
|
|
102
|
+
[trackPath()](./foundation-user.userpathhistory.trackpath.md)
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
</td><td>
|
|
106
|
+
|
|
107
|
+
Track current path.
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
</td></tr>
|
|
111
|
+
</tbody></table>
|
|
32
112
|
|
|
@@ -13,10 +13,102 @@ export interface UserQueueProperties
|
|
|
13
13
|
|
|
14
14
|
## Properties
|
|
15
15
|
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
16
|
+
<table><thead><tr><th>
|
|
17
|
+
|
|
18
|
+
Property
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
</th><th>
|
|
22
|
+
|
|
23
|
+
Modifiers
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
</th><th>
|
|
27
|
+
|
|
28
|
+
Type
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
</th><th>
|
|
32
|
+
|
|
33
|
+
Description
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
</th></tr></thead>
|
|
37
|
+
<tbody><tr><td>
|
|
38
|
+
|
|
39
|
+
[updateQueue](./foundation-user.userqueueproperties.updatequeue.md)
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
</td><td>
|
|
43
|
+
|
|
44
|
+
`readonly`
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
</td><td>
|
|
48
|
+
|
|
49
|
+
string
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
</td><td>
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
</td></tr>
|
|
56
|
+
<tr><td>
|
|
57
|
+
|
|
58
|
+
[zeroMqProxyInboundPort](./foundation-user.userqueueproperties.zeromqproxyinboundport.md)
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
</td><td>
|
|
62
|
+
|
|
63
|
+
`readonly`
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</td><td>
|
|
67
|
+
|
|
68
|
+
number
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
</td><td>
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
</td></tr>
|
|
75
|
+
<tr><td>
|
|
76
|
+
|
|
77
|
+
[zeroMqProxyModeEnabled](./foundation-user.userqueueproperties.zeromqproxymodeenabled.md)
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
</td><td>
|
|
81
|
+
|
|
82
|
+
`readonly`
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
</td><td>
|
|
86
|
+
|
|
87
|
+
boolean
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
</td><td>
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
</td></tr>
|
|
94
|
+
<tr><td>
|
|
95
|
+
|
|
96
|
+
[zeroMqProxyOutboundPort](./foundation-user.userqueueproperties.zeromqproxyoutboundport.md)
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
</td><td>
|
|
100
|
+
|
|
101
|
+
`readonly`
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
</td><td>
|
|
105
|
+
|
|
106
|
+
number
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
</td><td>
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
</td></tr>
|
|
113
|
+
</tbody></table>
|
|
22
114
|
|
package/docs/api/index.md
CHANGED
|
@@ -6,7 +6,25 @@
|
|
|
6
6
|
|
|
7
7
|
## Packages
|
|
8
8
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
9
|
+
<table><thead><tr><th>
|
|
10
|
+
|
|
11
|
+
Package
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
</th><th>
|
|
15
|
+
|
|
16
|
+
Description
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
</th></tr></thead>
|
|
20
|
+
<tbody><tr><td>
|
|
21
|
+
|
|
22
|
+
[@genesislcap/foundation-user](./foundation-user.md)
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
</td><td>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</td></tr>
|
|
29
|
+
</tbody></table>
|
|
12
30
|
|