AuthClientIdleOptions
Defined in: react/src/auth/types.ts:79
Idle-session configuration forwarded to the underlying AuthClient.
@icp-sdk/auth v8 only; see AuthenticationClientOptions.idleOptions.
Properties
Section titled “Properties”onIdle?
Section titled “onIdle?”
optionalonIdle?: () =>unknown
Defined in: react/src/auth/types.ts:81
Called once the user has been idle for idleTimeout ms.
Returns
Section titled “Returns”unknown
idleTimeout?
Section titled “idleTimeout?”
optionalidleTimeout?:number
Defined in: react/src/auth/types.ts:83
Idle timeout in ms.
Default
Section titled “Default”600_000 (10 minutes)captureScroll?
Section titled “captureScroll?”
optionalcaptureScroll?:boolean
Defined in: react/src/auth/types.ts:85
Treat scroll events as activity.
Default
Section titled “Default”falsescrollDebounce?
Section titled “scrollDebounce?”
optionalscrollDebounce?:number
Defined in: react/src/auth/types.ts:87
Scroll debounce in ms.
Default
Section titled “Default”100disableIdle?
Section titled “disableIdle?”
optionaldisableIdle?:boolean
Defined in: react/src/auth/types.ts:89
Disable idle detection entirely.
Default
Section titled “Default”falsedisableDefaultIdleCallback?
Section titled “disableDefaultIdleCallback?”
optionaldisableDefaultIdleCallback?:boolean
Defined in: react/src/auth/types.ts:94
Disable the built-in idle callback, which signs the user out and reloads the page.
Default
Section titled “Default”false