Theia API Documentation v1.65.0
Eclipse Theia Website
GitHub
Preparing search index...
@theia/core
browser/authentication-service
AuthenticationService
Interface AuthenticationService
interface
AuthenticationService
{
onDidChangeSessions
:
Event
<
{
event
:
AuthenticationProviderAuthenticationSessionsChangeEvent
;
label
:
string
;
providerId
:
string
;
}
,
>
;
onDidRegisterAuthenticationProvider
:
Event
<
AuthenticationProviderInformation
,
>
;
onDidUnregisterAuthenticationProvider
:
Event
<
AuthenticationProviderInformation
,
>
;
onDidUpdateSignInCount
:
Event
<
number
>
;
getLabel
(
providerId
:
string
)
:
string
;
getProviderIds
()
:
string
[]
;
getSessions
(
providerId
:
string
,
scopes
?:
string
[]
,
user
?:
AuthenticationSessionAccountInformation
,
)
:
Promise
<
readonly
AuthenticationSession
[]
>
;
isAuthenticationProviderRegistered
(
id
:
string
)
:
boolean
;
login
(
providerId
:
string
,
scopes
:
string
[]
,
options
?:
AuthenticationProviderSessionOptions
,
)
:
Promise
<
AuthenticationSession
>
;
logout
(
providerId
:
string
,
sessionId
:
string
)
:
Promise
<
void
>
;
registerAuthenticationProvider
(
id
:
string
,
provider
:
AuthenticationProvider
,
)
:
void
;
requestNewSession
(
id
:
string
,
scopes
:
string
[]
,
extensionId
:
string
,
extensionName
:
string
,
)
:
void
;
signOutOfAccount
(
providerId
:
string
,
accountName
:
string
)
:
Promise
<
void
>
;
supportsMultipleAccounts
(
providerId
:
string
)
:
boolean
;
unregisterAuthenticationProvider
(
id
:
string
)
:
void
;
updateSessions
(
providerId
:
string
,
event
:
AuthenticationProviderAuthenticationSessionsChangeEvent
,
)
:
void
;
}
Implemented by
AuthenticationServiceImpl
PluginAuthenticationServiceImpl
Index
Properties
on
Did
Change
Sessions
on
Did
Register
Authentication
Provider
on
Did
Unregister
Authentication
Provider
on
Did
Update
Sign
In
Count
Methods
get
Label
get
Provider
Ids
get
Sessions
is
Authentication
Provider
Registered
login
logout
register
Authentication
Provider
request
New
Session
sign
Out
Of
Account
supports
Multiple
Accounts
unregister
Authentication
Provider
update
Sessions
Properties
Readonly
on
Did
Change
Sessions
onDidChangeSessions
:
Event
<
{
event
:
AuthenticationProviderAuthenticationSessionsChangeEvent
;
label
:
string
;
providerId
:
string
;
}
,
>
Readonly
on
Did
Register
Authentication
Provider
onDidRegisterAuthenticationProvider
:
Event
<
AuthenticationProviderInformation
>
Readonly
on
Did
Unregister
Authentication
Provider
onDidUnregisterAuthenticationProvider
:
Event
<
AuthenticationProviderInformation
>
Readonly
on
Did
Update
Sign
In
Count
onDidUpdateSignInCount
:
Event
<
number
>
Methods
get
Label
getLabel
(
providerId
:
string
)
:
string
Parameters
providerId
:
string
Returns
string
get
Provider
Ids
getProviderIds
()
:
string
[]
Returns
string
[]
get
Sessions
getSessions
(
providerId
:
string
,
scopes
?:
string
[]
,
user
?:
AuthenticationSessionAccountInformation
,
)
:
Promise
<
readonly
AuthenticationSession
[]
>
Parameters
providerId
:
string
Optional
scopes
:
string
[]
Optional
user
:
AuthenticationSessionAccountInformation
Returns
Promise
<
readonly
AuthenticationSession
[]
>
is
Authentication
Provider
Registered
isAuthenticationProviderRegistered
(
id
:
string
)
:
boolean
Parameters
id
:
string
Returns
boolean
login
login
(
providerId
:
string
,
scopes
:
string
[]
,
options
?:
AuthenticationProviderSessionOptions
,
)
:
Promise
<
AuthenticationSession
>
Parameters
providerId
:
string
scopes
:
string
[]
Optional
options
:
AuthenticationProviderSessionOptions
Returns
Promise
<
AuthenticationSession
>
logout
logout
(
providerId
:
string
,
sessionId
:
string
)
:
Promise
<
void
>
Parameters
providerId
:
string
sessionId
:
string
Returns
Promise
<
void
>
register
Authentication
Provider
registerAuthenticationProvider
(
id
:
string
,
provider
:
AuthenticationProvider
,
)
:
void
Parameters
id
:
string
provider
:
AuthenticationProvider
Returns
void
request
New
Session
requestNewSession
(
id
:
string
,
scopes
:
string
[]
,
extensionId
:
string
,
extensionName
:
string
,
)
:
void
Parameters
id
:
string
scopes
:
string
[]
extensionId
:
string
extensionName
:
string
Returns
void
sign
Out
Of
Account
signOutOfAccount
(
providerId
:
string
,
accountName
:
string
)
:
Promise
<
void
>
Parameters
providerId
:
string
accountName
:
string
Returns
Promise
<
void
>
supports
Multiple
Accounts
supportsMultipleAccounts
(
providerId
:
string
)
:
boolean
Parameters
providerId
:
string
Returns
boolean
unregister
Authentication
Provider
unregisterAuthenticationProvider
(
id
:
string
)
:
void
Parameters
id
:
string
Returns
void
update
Sessions
updateSessions
(
providerId
:
string
,
event
:
AuthenticationProviderAuthenticationSessionsChangeEvent
,
)
:
void
Parameters
providerId
:
string
event
:
AuthenticationProviderAuthenticationSessionsChangeEvent
Returns
void
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
on
Did
Change
Sessions
on
Did
Register
Authentication
Provider
on
Did
Unregister
Authentication
Provider
on
Did
Update
Sign
In
Count
Methods
get
Label
get
Provider
Ids
get
Sessions
is
Authentication
Provider
Registered
login
logout
register
Authentication
Provider
request
New
Session
sign
Out
Of
Account
supports
Multiple
Accounts
unregister
Authentication
Provider
update
Sessions
Eclipse Theia Website
GitHub
Theia API Documentation v1.65.0
Loading...