概述
概述一键式社交登录插件。
视频教程
视频教程快速查看插件设置和登录流程的演示。
核心功能
概述initialize- 初始化插件。login- 使用所选提供商登录。logout- 登出。isLoggedIn- 已登录。
Public API
标题:Public API| 方法 | 描述 |
|---|---|
initialize | 初始化插件。 |
login | 使用选定的提供者登录。 |
logout | 注销。 |
isLoggedIn | 已登录。 |
getAuthorizationCode | 获取当前授权 code。 |
refresh | 刷新访问令牌。 |
refreshToken | OAuth2 刷新令牌助手(与 Capawesome OAuth 具有相同的功能性) |
handleRedirectCallback | Web-only: 处理 OAuth 重定向回调并返回解析结果。 |
decodeIdToken | 解析 JWT (通常为 OIDC ID 令牌) 以获取其声明。 |
getAccessTokenExpirationDate | 将访问令牌过期时间戳(以毫秒为单位的 Unix 时间戳)转换为 ISO 日期字符串。 |
isAccessTokenAvailable | 检查是否有可用的访问令牌(非空)。 |
isAccessTokenExpired | 检查访问令牌是否已过期。 |
isRefreshTokenAvailable | 检查是否有可用的刷新令牌(非空)。 |
providerSpecificCall | 执行提供商特定的调用。 |
getPluginVersion | 获取本机 Capacitor 插件版本。 |
openSecureWindow | 打开一个安全的窗口进行 OAuth2 认证。对于 Web,应在重定向页面中包含 code,以通过广播通道将重定向 URL 发送到应用程序。例如: html <html> <head></head> <body> <script> const searchParams = new URLSearchParams(location.search) if (searchParams.has("code")) { new BroadcastChannel("my-channel-name").postMessage(location.href); window.close(); } </script> </body> </html> 对于移动设备,应有一个打开应用的重定向 URI,例如: myapp://oauth_callback/ 并确保在应用的 info.plist 中注册它: xml <key>CFBundleURLTypes</key> <array> <dict> <key>CFBundleURLSchemes</key> <array> <string>myapp</string> </array> </dict> </array> 并在 AndroidManifest.xml 文件中注册它: xml <activity> <intent-filter> <action android:name="android.intent.action.VIEW" /> <category android:name="android.intent.category.DEFAULT" /> <category android:name="android.intent.category.BROWSABLE" /> <data android:host="oauth_callback" android:scheme="myapp" /> </intent-filter> </activity> . |
__CAPGO_KEEP_0__
“数据源”此参考资料是从 src/definitions.ts 在 capacitor-社会登录.