Theia API Documentation v1.65.0
Eclipse Theia Website
GitHub
Preparing search index...
@theia/plugin-ext
plugin/authentication-ext
AuthenticationExtImpl
Class AuthenticationExtImpl
Implements
AuthenticationExt
Index
Constructors
constructor
Properties
on
Did
Change
Sessions
Methods
$create
Session
$get
Sessions
$on
Did
Change
Authentication
Sessions
$remove
Session
get
Accounts
get
Session
register
Authentication
Provider
Constructors
constructor
new
AuthenticationExtImpl
(
rpc
:
RPCProtocol
)
:
AuthenticationExtImpl
Parameters
rpc
:
RPCProtocol
Returns
AuthenticationExtImpl
Properties
Readonly
on
Did
Change
Sessions
onDidChangeSessions
:
Event
<
AuthenticationSessionsChangeEvent
>
= ...
Methods
$create
Session
$createSession
(
providerId
:
string
,
scopes
:
string
[]
,
options
:
AuthenticationProviderSessionOptions
,
)
:
Promise
<
AuthenticationSession
>
Parameters
providerId
:
string
scopes
:
string
[]
options
:
AuthenticationProviderSessionOptions
Returns
Promise
<
AuthenticationSession
>
$get
Sessions
$getSessions
(
providerId
:
string
,
scopes
:
undefined
|
string
[]
,
options
:
AuthenticationProviderSessionOptions
,
)
:
Promise
<
readonly
AuthenticationSession
[]
>
Parameters
providerId
:
string
scopes
:
undefined
|
string
[]
options
:
AuthenticationProviderSessionOptions
Returns
Promise
<
readonly
AuthenticationSession
[]
>
$on
Did
Change
Authentication
Sessions
$onDidChangeAuthenticationSessions
(
provider
:
AuthenticationProviderInformation
,
)
:
Promise
<
void
>
Parameters
provider
:
AuthenticationProviderInformation
Returns
Promise
<
void
>
$remove
Session
$removeSession
(
providerId
:
string
,
sessionId
:
string
)
:
Promise
<
void
>
Parameters
providerId
:
string
sessionId
:
string
Returns
Promise
<
void
>
get
Accounts
getAccounts
(
providerId
:
string
,
)
:
Thenable
<
readonly
AuthenticationSessionAccountInformation
[]
>
Parameters
providerId
:
string
Returns
Thenable
<
readonly
AuthenticationSessionAccountInformation
[]
>
get
Session
getSession
(
requestingExtension
:
Plugin
,
providerId
:
string
,
scopes
:
readonly
string
[]
,
options
:
AuthenticationGetSessionOptions
&
(
|
{
createIfNone
:
true
}
|
{
forceNewSession
:
true
}
|
{
forceNewSession
:
AuthenticationGetSessionPresentationOptions
}
)
,
)
:
Promise
<
AuthenticationSession
>
Parameters
requestingExtension
:
Plugin
providerId
:
string
scopes
:
readonly
string
[]
options
:
AuthenticationGetSessionOptions
&
(
|
{
createIfNone
:
true
}
|
{
forceNewSession
:
true
}
|
{
forceNewSession
:
AuthenticationGetSessionPresentationOptions
}
)
Returns
Promise
<
AuthenticationSession
>
getSession
(
requestingExtension
:
Plugin
,
providerId
:
string
,
scopes
:
readonly
string
[]
,
options
:
AuthenticationGetSessionOptions
&
{
forceNewSession
:
true
}
,
)
:
Promise
<
AuthenticationSession
>
Parameters
requestingExtension
:
Plugin
providerId
:
string
scopes
:
readonly
string
[]
options
:
AuthenticationGetSessionOptions
&
{
forceNewSession
:
true
}
Returns
Promise
<
AuthenticationSession
>
getSession
(
requestingExtension
:
Plugin
,
providerId
:
string
,
scopes
:
readonly
string
[]
,
options
:
AuthenticationGetSessionOptions
&
{
forceNewSession
:
AuthenticationGetSessionPresentationOptions
;
}
,
)
:
Promise
<
AuthenticationSession
>
Parameters
requestingExtension
:
Plugin
providerId
:
string
scopes
:
readonly
string
[]
options
:
AuthenticationGetSessionOptions
&
{
forceNewSession
:
AuthenticationGetSessionPresentationOptions
;
}
Returns
Promise
<
AuthenticationSession
>
getSession
(
requestingExtension
:
Plugin
,
providerId
:
string
,
scopes
:
readonly
string
[]
,
options
:
AuthenticationGetSessionOptions
,
)
:
Promise
<
undefined
|
AuthenticationSession
>
Parameters
requestingExtension
:
Plugin
providerId
:
string
scopes
:
readonly
string
[]
options
:
AuthenticationGetSessionOptions
Returns
Promise
<
undefined
|
AuthenticationSession
>
register
Authentication
Provider
registerAuthenticationProvider
(
id
:
string
,
label
:
string
,
provider
:
AuthenticationProvider
,
options
?:
AuthenticationProviderOptions
,
)
:
Disposable
Parameters
id
:
string
label
:
string
provider
:
AuthenticationProvider
Optional
options
:
AuthenticationProviderOptions
Returns
Disposable
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
on
Did
Change
Sessions
Methods
$create
Session
$get
Sessions
$on
Did
Change
Authentication
Sessions
$remove
Session
get
Accounts
get
Session
register
Authentication
Provider
Eclipse Theia Website
GitHub
Theia API Documentation v1.65.0
Loading...