应用
需要先使用oauthapp发布工具创建应用,引入脚本库,替换 {{appid}} 。
初始化
获取应用的基本信息、配置项、文件列表。
提示
在 OAuthApp SDK 加载完成之前,调用 SDK 的其他方法将会报错。因此在使用 SDK 的其他方法之前,应该先调用 oauthapp.ready() 方法来确保 SDK 已经准备好使用。
初始化 + 自动注册账号
获取应用的基本信息、配置项、文件列表 + web指纹登录,可直接调用所有api。
提示
oauthapp.allReady()方法用于在oauthapp SDK中注册/登录用户并确保所有必要的依赖项都已加载并准备好使用。 此方法还将使用web指纹(fingerprintjs2)自动注册,如果账号不存在就自动注册;如果存在就自动登录,然后将用户信息赋值到window.oauthapp.appUser对象中。
提示
oauthapp.ready() 和 oauthapp.allReady() 都会初始化应用信息,但是 oauthapp.allReady() 会自动注册或登录用户信息,并将用户信息赋值到 window.oauthapp.appUser 对象中,以便在后续的操作中使用。这两个方法并没有先后顺序之分,可以根据具体的业务需求选择使用哪一个方法。
-
如果需要获取用户信息并进行后续操作,可以使用 oauthapp.allReady() 方法。
-
如果只需要初始化应用信息,可以使用 oauthapp.ready() 方法。
获取应用配置
使用发布工具配置,在 应用详情>>应用配置菜单下,配置后还需开启接口权限才能访问。
提示
用于获取 OAuthApp 应用中特定属性的值。这个方法接受一个参数 propertyCode,代表要获取的属性的代码。 通过调用此方法,您可以轻松地获取 OAuthApp 应用中的各种属性,例如应用名称、应用图标、应用描述等等。属性代码可以在 OAuthApp 应用管理页面中找到。 这个方法通常与其他 OAuthApp SDK 方法一起使用,以便根据应用配置来自定义 OAuth 登录体验,例如更改 OAuth 登录按钮的文本或样式等。
参数 | 说明 | |
---|---|---|
propertyCode | 配置项的code |
重置meat标签
会自动重置页面的title、icon、描述信息,具体可在后台配置。
提示
用于重置 HTML 页面中的所有 OAuthApp 相关标记(meta 标签、title 标签、facicon 标签等),以便重新初始化 OAuthApp 应用程序信息,而无需手动更改 HTML 页面。
属性
名称 | 说明 | 参数 |
---|---|---|
oauthapp.app | 应用数据 | 需在“oauthapp.ready”或“oauthapp.allReady”方法后使用 |
oauthapp.app.info | 应用基本信息 | 使用发布工具配置:应用>>基本信息 菜单下 |
oauthapp.app.blobs | 应用文件存储列表 | 使用发布工具配置:应用>>存储 菜单下 |
oauthapp.app.props | 应用前端配置集合 | 使用发布工具配置:应用>>应用配置——client配置节 菜单下 |
oauthapp.appUser | 用户数据 | 需在“oauthapp.allReady”方法后使用 |
oauthapp.settings.access_token | 当前登录用户的令牌 | |
oauthapp.settings.appid | 应用id | |
oauthapp.settings.fingerIdentity | 当前设备web指纹 | |
oauthapp.settings.server | 服务器地址 |