接口:AuthenticationGetSessionOptions
定义于:packages/extension-api/src/extension-api.d.ts:4140
从 AuthenticationProvider 获取 AuthenticationSession 时使用的选项。
属性
clearSessionPreference?
可选
clearSessionPreference:boolean
定义于:packages/extension-api/src/extension-api.d.ts:4164
是否应清除现有的用户会话偏好设置。
对于支持一次登录多个账户的认证提供者,在调用 getSession 时,用户将被提示选择要使用的账户。此偏好设置将一直保留,直到使用此标志调用 getSession。
默认为 false。
createIfNone?
可选
createIfNone:boolean
定义于:packages/extension-api/src/extension-api.d.ts:4153
如果没有匹配的会话,是否应执行登录。
如果为 true,将显示一个模态对话框,要求用户登录。如果为 false,将在账户活动栏图标上显示一个数字徽章。将在菜单下添加一个扩展条目以进行登录。这允许悄悄提示用户登录。
如果存在匹配的会话但扩展尚未获得访问权限,则将此设置为 true 也会导致立即显示模态对话框,而 false 将在账户图标上添加数字徽章。
默认为 false。
forceNewSession?
可选
forceNewSession:boolean
| {detail
:string
; }
定义于:packages/extension-api/src/extension-api.d.ts:4177
是否应尝试重新认证,即使已有可用会话。
如果为 true,将显示一个模态对话框,要求用户再次登录。这主要用于需要重新颁发令牌的场景,因为令牌已丢失某些授权。
如果不存在现有会话且 forceNewSession 为 true,则其行为与 createIfNone 完全相同。
默认为 false。
silent?
可选
silent:boolean
定义于:packages/extension-api/src/extension-api.d.ts:4189
是否应在“账户”菜单中显示登录指示。
如果为 false,将向用户显示“账户”菜单上的徽章,其中包含一个用于扩展登录的选项。如果为 true,则不显示任何指示。
默认为 false。
注意:不能将此选项与任何其他会提示用户的选项(如 createIfNone)一起使用。