npm - @genesislcap/foundation-user - Versions diffs - 14.408.0 → 14.409.0-FUI-2495.2 - Mend

@genesislcap/foundation-user 14.408.0 → 14.409.0-FUI-2495.2

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.

Files changed (107) hide show

package/docs/api/foundation-user.setuserproperties.md DELETED Viewed

@@ -1,154 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [SetUserProperties](./foundation-user.setuserproperties.md)
-## SetUserProperties interface
-SetUserProperties is a partial match of `LoginAck` from `@genesislcap/foundation-auth`<!-- -->.
-**Signature:**
-```typescript
-export interface SetUserProperties extends Partial<UserQueueProperties>
-```
-**Extends:** Partial&lt;[UserQueueProperties](./foundation-user.userqueueproperties.md)<!-- -->&gt;
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[details](./foundation-user.setuserproperties.details.md)
-</td><td>
-`readonly`
-</td><td>
-[UserDetailsProperty](./foundation-user.userdetailsproperty.md)
-</td><td>
-</td></tr>
-<tr><td>
-[permission](./foundation-user.setuserproperties.permission.md)
-</td><td>
-`readonly`
-</td><td>
-string\[\]
-</td><td>
-</td></tr>
-<tr><td>
-[profile](./foundation-user.setuserproperties.profile.md)
-</td><td>
-`readonly`
-</td><td>
-string\[\]
-</td><td>
-</td></tr>
-<tr><td>
-[sourceRef](./foundation-user.setuserproperties.sourceref.md)
-</td><td>
-`readonly`
-</td><td>
-string
-</td><td>
-</td></tr>
-<tr><td>
-[userKVs](./foundation-user.setuserproperties.userkvs.md)
-</td><td>
-`readonly`
-</td><td>
-[UserKVsProperty](./foundation-user.userkvsproperty.md)
-</td><td>
-</td></tr>
-<tr><td>
-[userName](./foundation-user.setuserproperties.username.md)
-</td><td>
-`readonly`
-</td><td>
-string
-</td><td>
-</td></tr>
-</tbody></table>

package/docs/api/foundation-user.setuserproperties.permission.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [SetUserProperties](./foundation-user.setuserproperties.md) &gt; [permission](./foundation-user.setuserproperties.permission.md)
-## SetUserProperties.permission property
-**Signature:**
-```typescript
-readonly permission: string[];
-```

package/docs/api/foundation-user.setuserproperties.profile.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [SetUserProperties](./foundation-user.setuserproperties.md) &gt; [profile](./foundation-user.setuserproperties.profile.md)
-## SetUserProperties.profile property
-**Signature:**
-```typescript
-readonly profile: string[];
-```

package/docs/api/foundation-user.setuserproperties.sourceref.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [SetUserProperties](./foundation-user.setuserproperties.md) &gt; [sourceRef](./foundation-user.setuserproperties.sourceref.md)
-## SetUserProperties.sourceRef property
-**Signature:**
-```typescript
-readonly sourceRef: string;
-```

package/docs/api/foundation-user.setuserproperties.userkvs.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [SetUserProperties](./foundation-user.setuserproperties.md) &gt; [userKVs](./foundation-user.setuserproperties.userkvs.md)
-## SetUserProperties.userKVs property
-**Signature:**
-```typescript
-readonly userKVs: UserKVsProperty;
-```

package/docs/api/foundation-user.setuserproperties.username.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [SetUserProperties](./foundation-user.setuserproperties.md) &gt; [userName](./foundation-user.setuserproperties.username.md)
-## SetUserProperties.userName property
-**Signature:**
-```typescript
-readonly userName: string;
-```

package/docs/api/foundation-user.user.addauthenticationchangelistener.md DELETED Viewed

@@ -1,61 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [User](./foundation-user.user.md) &gt; [addAuthenticationChangeListener](./foundation-user.user.addauthenticationchangelistener.md)
-## User.addAuthenticationChangeListener() method
-**Signature:**
-```typescript
-addAuthenticationChangeListener(listener: Listener<UserAuthenticationChangeEvent>): () => void;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-listener
-</td><td>
-Listener&lt;[UserAuthenticationChangeEvent](./foundation-user.userauthenticationchangeevent.md)<!-- -->&gt;
-</td><td>
-A listener function.
-</td></tr>
-</tbody></table>
-**Returns:**
-() =&gt; void
-## Example
-```ts
-const unsubscribe = this.user.addAuthenticationChangeListener((event) => {
-  console.log('User authenticated?', event.detail);
-});
-```

package/docs/api/foundation-user.user.cleartrackinghistory.md DELETED Viewed

@@ -1,15 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [User](./foundation-user.user.md) &gt; [clearTrackingHistory](./foundation-user.user.cleartrackinghistory.md)
-## User.clearTrackingHistory() method
-**Signature:**
-```typescript
-clearTrackingHistory(): void;
-```
-**Returns:**
-void

package/docs/api/foundation-user.user.details.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [User](./foundation-user.user.md) &gt; [details](./foundation-user.user.details.md)
-## User.details property
-**Signature:**
-```typescript
-readonly details: SetUserProperties['details'];
-```

package/docs/api/foundation-user.user.haspermission.md DELETED Viewed

@@ -1,52 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [User](./foundation-user.user.md) &gt; [hasPermission](./foundation-user.user.haspermission.md)
-## User.hasPermission() method
-**Signature:**
-```typescript
-hasPermission(permission: string | string[]): boolean;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-permission
-</td><td>
-string \| string\[\]
-</td><td>
-A permission string or an array of permission strings to check.
-</td></tr>
-</tbody></table>
-**Returns:**
-boolean

package/docs/api/foundation-user.user.hasprofile.md DELETED Viewed

@@ -1,52 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [User](./foundation-user.user.md) &gt; [hasProfile](./foundation-user.user.hasprofile.md)
-## User.hasProfile() method
-**Signature:**
-```typescript
-hasProfile(profile: string | string[]): boolean;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-profile
-</td><td>
-string \| string\[\]
-</td><td>
-A profile string or an array of profile strings to check.
-</td></tr>
-</tbody></table>
-**Returns:**
-boolean

package/docs/api/foundation-user.user.isadmin.md DELETED Viewed

@@ -1,15 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [User](./foundation-user.user.md) &gt; [isAdmin](./foundation-user.user.isadmin.md)
-## User.isAdmin() method
-**Signature:**
-```typescript
-isAdmin(): boolean;
-```
-**Returns:**
-boolean

package/docs/api/foundation-user.user.isanonymous.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [User](./foundation-user.user.md) &gt; [isAnonymous](./foundation-user.user.isanonymous.md)
-## User.isAnonymous property
-**Signature:**
-```typescript
-readonly isAnonymous: boolean;
-```

package/docs/api/foundation-user.user.isauthenticated.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [User](./foundation-user.user.md) &gt; [isAuthenticated](./foundation-user.user.isauthenticated.md)
-## User.isAuthenticated property
-**Signature:**
-```typescript
-readonly isAuthenticated: boolean;
-```

package/docs/api/foundation-user.user.isbanned.md DELETED Viewed

@@ -1,15 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-user](./foundation-user.md) &gt; [User](./foundation-user.user.md) &gt; [isBanned](./foundation-user.user.isbanned.md)
-## User.isBanned() method
-**Signature:**
-```typescript
-isBanned(): boolean;
-```
-**Returns:**
-boolean