@ng-idle/core
Version:
A module for detecting and responding to the user becoming idle in Angular applications.
70 lines • 2.38 kB
TypeScript
import { EventEmitter, NgZone, OnDestroy } from '@angular/core';
import { IdleExpiry } from './idleexpiry';
import { Interrupt } from './interrupt';
import { InterruptSource } from './interruptsource';
import { KeepaliveSvc } from './keepalivesvc';
import * as i0 from "@angular/core";
export declare enum AutoResume {
disabled = 0,
idle = 1,
notIdle = 2
}
/**
* A service for detecting and responding to user idleness.
*/
export declare class Idle implements OnDestroy {
private expiry;
private zone;
private platformId?;
private idle;
private timeoutVal;
private autoResume;
private interrupts;
private running;
private idling;
private idleHandle;
private timeoutHandle;
private countdown;
private keepaliveEnabled;
private keepaliveSvc;
onIdleStart: EventEmitter<any>;
onIdleEnd: EventEmitter<any>;
onTimeoutWarning: EventEmitter<number>;
onTimeout: EventEmitter<number>;
onInterrupt: EventEmitter<any>;
[key: string]: any;
constructor(expiry: IdleExpiry, zone: NgZone, keepaliveSvc?: KeepaliveSvc, platformId?: Object);
setIdleName(key: string): void;
getKeepaliveEnabled(): boolean;
setKeepaliveEnabled(value: boolean): boolean;
getTimeout(): number;
setTimeout(seconds: number | boolean): number;
getIdle(): number;
setIdle(seconds: number): number;
getAutoResume(): AutoResume;
setAutoResume(value: AutoResume): AutoResume;
setInterrupts(sources: Array<InterruptSource>): Array<Interrupt>;
getInterrupts(): Array<Interrupt>;
clearInterrupts(): void;
isRunning(): boolean;
isIdling(): boolean;
watch(skipExpiry?: boolean): void;
setIdleIntervalOutsideOfZone(watchFn: () => void, frequency: number): void;
stop(): void;
timeout(): void;
interrupt(force?: boolean, eventArgs?: any): void;
private setIdling;
private toggleState;
private setTimeoutIntervalOutsideZone;
private toggleInterrupts;
private getExpiryDiff;
private doCountdownInZone;
private doCountdown;
private safeClearInterval;
private startKeepalive;
private stopKeepalive;
ngOnDestroy(): void;
static ɵfac: i0.ɵɵFactoryDeclaration<Idle, [null, null, { optional: true; }, { optional: true; }]>;
static ɵprov: i0.ɵɵInjectableDeclaration<Idle>;
}
//# sourceMappingURL=idle.d.ts.map