dots.vscode.authentication-get-session-options
Options to be used when getting an {@link AuthenticationSession } from an {@link AuthenticationProvider }.
Options to be used when getting an {@link AuthenticationSession } from an {@link AuthenticationProvider }.
clear-session-preference?cljs
(clear-session-preference? authentication-get-session-options)Whether the existing session preference should be cleared.
For authentication providers that support being signed into multiple accounts at once, the user will be prompted to select an account to use when {@link authentication.getSession getSession} is called. This preference is remembered until {@link authentication.getSession getSession} is called with this flag.
Note: The preference is extension specific. So if one extension calls {@link authentication.getSession getSession}, it will not affect the session preference for another extension calling {@link authentication.getSession getSession}. Additionally, the preference is set for the current workspace and also globally. This means that new workspaces will use the "global" value at first and then when this flag is provided, a new value can be set for that workspace. This also means that pre-existing workspaces will not lose their preference if a new workspace sets this flag.
Defaults to false.
Returns: boolean | undefined
Whether the existing session preference should be cleared.
For authentication providers that support being signed into multiple accounts at once, the user will be
prompted to select an account to use when {@link authentication.getSession getSession} is called. This preference
is remembered until {@link authentication.getSession getSession} is called with this flag.
Note:
The preference is extension specific. So if one extension calls {@link authentication.getSession getSession}, it will not
affect the session preference for another extension calling {@link authentication.getSession getSession}. Additionally,
the preference is set for the current workspace and also globally. This means that new workspaces will use the "global"
value at first and then when this flag is provided, a new value can be set for that workspace. This also means
that pre-existing workspaces will not lose their preference if a new workspace sets this flag.
Defaults to false.
**Returns:** `boolean | undefined`create-if-none?cljs
(create-if-none? authentication-get-session-options)Whether login should be performed if there is no matching session.
If true, a modal dialog will be shown asking the user to sign in. If false, a numbered badge will be shown on the accounts activity bar icon. An entry for the extension will be added under the menu to sign in. This allows quietly prompting the user to sign in.
If there is a matching session but the extension has not been granted access to it, setting this to true will also result in an immediate modal dialog, and false will add a numbered badge to the accounts icon.
Defaults to false.
Note: you cannot use this option with {@link AuthenticationGetSessionOptions.silent silent}.
Returns: boolean | undefined
Whether login should be performed if there is no matching session.
If true, a modal dialog will be shown asking the user to sign in. If false, a numbered badge will be shown
on the accounts activity bar icon. An entry for the extension will be added under the menu to sign in. This
allows quietly prompting the user to sign in.
If there is a matching session but the extension has not been granted access to it, setting this to true
will also result in an immediate modal dialog, and false will add a numbered badge to the accounts icon.
Defaults to false.
Note: you cannot use this option with {@link AuthenticationGetSessionOptions.silent silent}.
**Returns:** `boolean | undefined`force-new-session?cljs
(force-new-session? authentication-get-session-options)Whether we should attempt to reauthenticate even if there is already a session available.
If true, a modal dialog will be shown asking the user to sign in again. This is mostly used for scenarios where the token needs to be re minted because it has lost some authorization.
If there are no existing sessions and forceNewSession is true, it will behave identically to {@link AuthenticationGetSessionOptions.createIfNone createIfNone}.
This defaults to false.
Returns: boolean | AuthenticationForceNewSessionOptions | undefined
Whether we should attempt to reauthenticate even if there is already a session available.
If true, a modal dialog will be shown asking the user to sign in again. This is mostly used for scenarios
where the token needs to be re minted because it has lost some authorization.
If there are no existing sessions and forceNewSession is true, it will behave identically to
{@link AuthenticationGetSessionOptions.createIfNone createIfNone}.
This defaults to false.
**Returns:** `boolean | AuthenticationForceNewSessionOptions | undefined`set-clear-session-preference!cljs
(set-clear-session-preference! authentication-get-session-options value)Whether the existing session preference should be cleared.
For authentication providers that support being signed into multiple accounts at once, the user will be prompted to select an account to use when {@link authentication.getSession getSession} is called. This preference is remembered until {@link authentication.getSession getSession} is called with this flag.
Note: The preference is extension specific. So if one extension calls {@link authentication.getSession getSession}, it will not affect the session preference for another extension calling {@link authentication.getSession getSession}. Additionally, the preference is set for the current workspace and also globally. This means that new workspaces will use the "global" value at first and then when this flag is provided, a new value can be set for that workspace. This also means that pre-existing workspaces will not lose their preference if a new workspace sets this flag.
Defaults to false.
Whether the existing session preference should be cleared.
For authentication providers that support being signed into multiple accounts at once, the user will be
prompted to select an account to use when {@link authentication.getSession getSession} is called. This preference
is remembered until {@link authentication.getSession getSession} is called with this flag.
Note:
The preference is extension specific. So if one extension calls {@link authentication.getSession getSession}, it will not
affect the session preference for another extension calling {@link authentication.getSession getSession}. Additionally,
the preference is set for the current workspace and also globally. This means that new workspaces will use the "global"
value at first and then when this flag is provided, a new value can be set for that workspace. This also means
that pre-existing workspaces will not lose their preference if a new workspace sets this flag.
Defaults to false.set-create-if-none!cljs
(set-create-if-none! authentication-get-session-options value)Whether login should be performed if there is no matching session.
If true, a modal dialog will be shown asking the user to sign in. If false, a numbered badge will be shown on the accounts activity bar icon. An entry for the extension will be added under the menu to sign in. This allows quietly prompting the user to sign in.
If there is a matching session but the extension has not been granted access to it, setting this to true will also result in an immediate modal dialog, and false will add a numbered badge to the accounts icon.
Defaults to false.
Note: you cannot use this option with {@link AuthenticationGetSessionOptions.silent silent}.
Whether login should be performed if there is no matching session.
If true, a modal dialog will be shown asking the user to sign in. If false, a numbered badge will be shown
on the accounts activity bar icon. An entry for the extension will be added under the menu to sign in. This
allows quietly prompting the user to sign in.
If there is a matching session but the extension has not been granted access to it, setting this to true
will also result in an immediate modal dialog, and false will add a numbered badge to the accounts icon.
Defaults to false.
Note: you cannot use this option with {@link AuthenticationGetSessionOptions.silent silent}.set-force-new-session!cljs
(set-force-new-session! authentication-get-session-options value)Whether we should attempt to reauthenticate even if there is already a session available.
If true, a modal dialog will be shown asking the user to sign in again. This is mostly used for scenarios where the token needs to be re minted because it has lost some authorization.
If there are no existing sessions and forceNewSession is true, it will behave identically to {@link AuthenticationGetSessionOptions.createIfNone createIfNone}.
This defaults to false.
Whether we should attempt to reauthenticate even if there is already a session available.
If true, a modal dialog will be shown asking the user to sign in again. This is mostly used for scenarios
where the token needs to be re minted because it has lost some authorization.
If there are no existing sessions and forceNewSession is true, it will behave identically to
{@link AuthenticationGetSessionOptions.createIfNone createIfNone}.
This defaults to false.set-silent!cljs
(set-silent! authentication-get-session-options value)Whether we should show the indication to sign in in the Accounts menu.
If false, the user will be shown a badge on the Accounts menu with an option to sign in for the extension. If true, no indication will be shown.
Defaults to false.
Note: you cannot use this option with any other options that prompt the user like {@link AuthenticationGetSessionOptions.createIfNone createIfNone}.
Whether we should show the indication to sign in in the Accounts menu.
If false, the user will be shown a badge on the Accounts menu with an option to sign in for the extension.
If true, no indication will be shown.
Defaults to false.
Note: you cannot use this option with any other options that prompt the user like {@link AuthenticationGetSessionOptions.createIfNone createIfNone}.silent?cljs
(silent? authentication-get-session-options)Whether we should show the indication to sign in in the Accounts menu.
If false, the user will be shown a badge on the Accounts menu with an option to sign in for the extension. If true, no indication will be shown.
Defaults to false.
Note: you cannot use this option with any other options that prompt the user like {@link AuthenticationGetSessionOptions.createIfNone createIfNone}.
Returns: boolean | undefined
Whether we should show the indication to sign in in the Accounts menu.
If false, the user will be shown a badge on the Accounts menu with an option to sign in for the extension.
If true, no indication will be shown.
Defaults to false.
Note: you cannot use this option with any other options that prompt the user like {@link AuthenticationGetSessionOptions.createIfNone createIfNone}.
**Returns:** `boolean | undefined`cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close