@genesislcap/foundation-utils 14.314.1 → 14.314.3-alpha-c442ac5.0

package/docs/api/foundation-utils.inactivityevents.md

@@ -0,0 +1,88 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [InactivityEvents](./foundation-utils.inactivityevents.md)
+
+## InactivityEvents interface
+
+**Signature:**
+
+```typescript
+export interface InactivityEvents 
+```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+["inactivity-reset"](./foundation-utils.inactivityevents._inactivity-reset_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+void
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+["inactivity-timeout"](./foundation-utils.inactivityevents._inactivity-timeout_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+void
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+["inactivity-warning"](./foundation-utils.inactivityevents._inactivity-warning_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ remainingSeconds: number; }
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/foundation-utils.inactivitymanager._constructor_.md

@@ -0,0 +1,48 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [InactivityManager](./foundation-utils.inactivitymanager.md) &gt; [(constructor)](./foundation-utils.inactivitymanager._constructor_.md)
+
+## InactivityManager.(constructor)
+
+Constructs a new instance of the `InactivityManager` class
+
+**Signature:**
+
+```typescript
+constructor(config: InactivityManagerConfig);
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+config
+
+
+</td><td>
+
+[InactivityManagerConfig](./foundation-utils.inactivitymanagerconfig.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/foundation-utils.inactivitymanager.destroy.md

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

package/docs/api/foundation-utils.inactivitymanager.getservice.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [InactivityManager](./foundation-utils.inactivitymanager.md) &gt; [getService](./foundation-utils.inactivitymanager.getservice.md)
+
+## InactivityManager.getService() method
+
+**Signature:**
+
+```typescript
+getService(): InactivityService;
+```
+**Returns:**
+
+[InactivityService](./foundation-utils.inactivityservice.md)
+

package/docs/api/foundation-utils.inactivitymanager.iswarningvisible.md

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

package/docs/api/foundation-utils.inactivitymanager.md

@@ -0,0 +1,138 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [InactivityManager](./foundation-utils.inactivitymanager.md)
+
+## InactivityManager class
+
+**Signature:**
+
+```typescript
+export declare class InactivityManager 
+```
+
+## Constructors
+
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)(config)](./foundation-utils.inactivitymanager._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Constructs a new instance of the `InactivityManager` class
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[destroy()](./foundation-utils.inactivitymanager.destroy.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[getService()](./foundation-utils.inactivitymanager.getservice.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[isWarningVisible()](./foundation-utils.inactivitymanager.iswarningvisible.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[reset()](./foundation-utils.inactivitymanager.reset.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[start()](./foundation-utils.inactivitymanager.start.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[stop()](./foundation-utils.inactivitymanager.stop.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/foundation-utils.inactivitymanager.reset.md

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

package/docs/api/foundation-utils.inactivitymanager.start.md

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

package/docs/api/foundation-utils.inactivitymanager.stop.md

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

package/docs/api/foundation-utils.inactivitymanagerconfig.md

@@ -0,0 +1,55 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [InactivityManagerConfig](./foundation-utils.inactivitymanagerconfig.md)
+
+## InactivityManagerConfig interface
+
+**Signature:**
+
+```typescript
+export interface InactivityManagerConfig extends InactivityConfig 
+```
+**Extends:** [InactivityConfig](./foundation-utils.inactivityconfig.md)
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[onLogout](./foundation-utils.inactivitymanagerconfig.onlogout.md)
+
+
+</td><td>
+
+
+</td><td>
+
+() =&gt; void
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/foundation-utils.inactivitymanagerconfig.onlogout.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [InactivityManagerConfig](./foundation-utils.inactivitymanagerconfig.md) &gt; [onLogout](./foundation-utils.inactivitymanagerconfig.onlogout.md)
+
+## InactivityManagerConfig.onLogout property
+
+**Signature:**
+
+```typescript
+onLogout: () => void;
+```

package/docs/api/foundation-utils.inactivityservice._constructor_.md

@@ -0,0 +1,48 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [InactivityService](./foundation-utils.inactivityservice.md) &gt; [(constructor)](./foundation-utils.inactivityservice._constructor_.md)
+
+## InactivityService.(constructor)
+
+Constructs a new instance of the `InactivityService` class
+
+**Signature:**
+
+```typescript
+constructor(config: InactivityConfig);
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+config
+
+
+</td><td>
+
+[InactivityConfig](./foundation-utils.inactivityconfig.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/foundation-utils.inactivityservice.destroy.md

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

package/docs/api/foundation-utils.inactivityservice.md

@@ -0,0 +1,138 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [InactivityService](./foundation-utils.inactivityservice.md)
+
+## InactivityService class
+
+**Signature:**
+
+```typescript
+export declare class InactivityService 
+```
+
+## Constructors
+
+<table><thead><tr><th>
+
+Constructor
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[(constructor)(config)](./foundation-utils.inactivityservice._constructor_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Constructs a new instance of the `InactivityService` class
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[destroy()](./foundation-utils.inactivityservice.destroy.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[off(event, listener)](./foundation-utils.inactivityservice.off.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[on(event, listener)](./foundation-utils.inactivityservice.on.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[resetTimer()](./foundation-utils.inactivityservice.resettimer.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[start()](./foundation-utils.inactivityservice.start.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[stop()](./foundation-utils.inactivityservice.stop.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+

package/docs/api/foundation-utils.inactivityservice.off.md

@@ -0,0 +1,64 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-utils](./foundation-utils.md) &gt; [InactivityService](./foundation-utils.inactivityservice.md) &gt; [off](./foundation-utils.inactivityservice.off.md)
+
+## InactivityService.off() method
+
+**Signature:**
+
+```typescript
+off<K extends keyof InactivityEvents>(event: K, listener: EventListener<InactivityEvents[K]>): void;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+event
+
+
+</td><td>
+
+K
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+listener
+
+
+</td><td>
+
+EventListener&lt;[InactivityEvents](./foundation-utils.inactivityevents.md)<!-- -->\[K\]&gt;
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+void
+