跳至主要内容

接口:AuthenticationGetSessionOptions

身份验证提供者 获取 身份验证会话 时要使用的选项。

属性

clearSessionPreference?

optional clearSessionPreference: boolean

是否应清除现有的用户会话首选项。

对于支持同时登录多个帐户的身份验证提供者,当调用 getSession 时,系统将提示用户选择要使用的帐户。此首选项会一直保留,直到使用此标志调用 getSession

默认值为 false。

定义于

packages/extension-api/src/extension-api.d.ts:4016


createIfNone?

optional createIfNone: boolean

如果没有匹配的会话,是否应执行登录。

如果为 true,则将显示一个模式对话框,要求用户登录。如果为 false,则帐户活动栏图标上将显示一个编号徽章。扩展程序的条目将在菜单下添加,以供登录。这允许静默提示用户登录。

如果存在匹配的会话,但扩展程序未被授予访问权限,则将其设置为 true 也会导致立即显示模式对话框,而 false 则会在帐户图标上添加一个编号徽章。

默认值为 false。

定义于

packages/extension-api/src/extension-api.d.ts:4005


forceNewSession?

optional forceNewSession: boolean | object

是否应尝试重新验证,即使已经有会话可用。

如果为 true,则将显示一个模式对话框,要求用户再次登录。这主要用于令牌需要重新铸造的情况,因为令牌已失去某些授权。

如果不存在现有会话,并且 forceNewSession 为 true,则其行为与 createIfNone 相同。

这默认为 false。

定义于

packages/extension-api/src/extension-api.d.ts:4029


silent?

optional silent: boolean

是否应显示在帐户菜单中登录的指示。

如果为 false,则用户将在帐户菜单上看到一个徽章,其中包含一个选项,允许用户为扩展程序登录。如果为 true,则不会显示任何指示。

默认值为 false。

注意:您不能将此选项与任何其他提示用户的选项一起使用,例如 createIfNone

定义于

packages/extension-api/src/extension-api.d.ts:4041