chrome.loginState

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

Summary

"SIGNIN_PROFILE"

, or

"USER_PROFILE"

"UNKNOWN"

"IN_OOBE_SCREEN"

"IN_LOGIN_SCREEN"

"IN_SESSION"

"IN_LOCK_SCREEN"

, or

"IN_RMA_SCREEN"

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>
Pending
This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to 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>
Pending
This only returns a Promise when the callback parameter is not specified, and with MV3+. The type inside the Promise is the same as the 1st argument to 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