chrome.loginState

Important: This API works only on ChromeOS

Description
Use the chrome.loginState API to read and monitor the login state.
Permissions
loginState
Availability
Chrome 78+ ChromeOS only

Summary

"SIGNIN_PROFILE"
Specifies that the extension is in the signin profile.

"USER_PROFILE"
Specifies that the extension is in the user profile.

"UNKNOWN"
Specifies that the session state is unknown.

"IN_OOBE_SCREEN"
Specifies that the user is in the out-of-box-experience screen.

"IN_LOGIN_SCREEN"
Specifies that the user is in the login screen.

"IN_SESSION"
Specifies that the user is in the session.

"IN_LOCK_SCREEN"
Specifies that the user is in the lock screen.

"IN_RMA_SCREEN"
Specifies that the device is in RMA mode, finalizing repairs.


          
          
            chrome.loginState.getProfileType(

        callback?:
  function,

      
    )

Promise

Gets the type of the profile the extension is in.

callback
function optional
The callback parameter looks like: (result: ProfileType) => void
- result
  ProfileType

Promise<ProfileType>
Chrome 96+
Promises are supported in Manifest V3 and later, but callbacks are provided for backward compatibility. You cannot use both on the same function call. The promise resolves with the same type that is passed to the callback.


          
          
            chrome.loginState.getSessionState(

        callback?:
  function,

      
    )

Promise

Gets the current session state.

callback
function optional
The callback parameter looks like: (result: SessionState) => void
- result
  SessionState

Promise<SessionState>
Chrome 96+
Promises are supported in Manifest V3 and later, but callbacks are provided for backward compatibility. You cannot use both on the same function call. The promise resolves with the same type that is passed to the callback.


          
          
            chrome.loginState.onSessionStateChanged.addListener(

        callback:
  function,

      
    )

Dispatched when the session state changes. sessionState is the new session state.

callback
function
The callback parameter looks like: (sessionState: SessionState) => void
- sessionState
  SessionState

Table of contents