Appearance
user.ref
ユーザーへの参照です。
プロパティ
admin
要認証エリアへのアクセスです。
authorized
type
boolean
認証済みかどうかです。
type
string
ユーザーのメールアドレスです。
refreshToken
type
string
type
null
リフレッシュトークンです。このトークンを用いて認証トークンを更新します。
WARNING
必要なリフレッシュトークンに有効期限は無く、このトークンがあれば容易にログインが出来てしまうため、取り扱いには注意が必要です。
clearAuth() を実行する事でリフレッシュトークンを無効化出来るので、要認証操作が不要になった場合は clearAuth() の実行を忘れないようにして下さい。
timeRemaining
type
number
現在のトークンが認証切れになるまでの msec 単位の時間です。未認証の場合は -1 が返ります。
token
type
string
type
null
認証トークンです。
INFO
このトークンは短命で 1 時間で有効期限が切れますが、内部で 50 分毎に更新をかけています。
tokenExpiredAt
type
number
type
null
現在のトークンが認証切れになる Unix 時間です。未認証の場合は null が返ります。
メソッド
clearAuth()
内部で保持している認証情報を破棄し、リフレッシュトークンを無効にします。
使用方法
ts
await Hedgehog.user.ref("メールアドレス").clearAuth();getAuthorizedHeader()
| 引数 | 必須 | 型 | 内容 |
|---|---|---|---|
| required | boolean | 未認証時にエラーとするか |
type
object
API との通信時に使用する認証ヘッダを取得します。SDK 内で API と通信する箇所で内部的に呼び出されます。
使用方法
ts
const header = await Hedgehog.user
.ref("メールアドレス")
.getAuthorizedHeader();getUserRoleForStage()
| 引数 | 必須 | 型 | 内容 |
|---|---|---|---|
| stageUuid | ✓ | string | ステージのUUID |
type
Promise<UserType>
ユーザーのステージに対する権限を取得します。
使用方法
ts
const user = await Hedgehog.user.ref("メールアドレス").signin("パスワード");
const role = await user.getUserRoleForStage("ステージのUUID");setToken()
| 引数 | 必須 | 型 | 内容 |
|---|---|---|---|
| token | ✓ | string | トークン |
| refreshToken | ✓ | string | リフレッシュトークン |
type
UserReference →トークンとリフレッシュトークンをセットします。
INFO
与えられたトークンの有効期限が切れていた場合、即座に更新が行われます。
使用方法
ts
Hedgehog.user
.ref("メールアドレス")
.setToken("トークン", "リフレッシュトークン");signin()
| 引数 | 必須 | 型 | 内容 |
|---|---|---|---|
| password | ✓ | string | パスワード |
パスワードを用いてサインインを行います。
使用方法
ts
await Hedgehog.user.ref("メールアドレス").signin("パスワード");signinWithRefreshToken()
| 引数 | 必須 | 型 | 内容 |
|---|---|---|---|
| refreshToken | ✓ | string | リフレッシュトークン |
リフレッシュトークンを用いてサインインを行います。
使用方法
ts
await Hedgehog.user
.ref("メールアドレス")
.signinWithRefreshToken("リフレッシュトークン");updateToken()
type
Promise<void>
リフレッシュトークンを用いてトークンの更新を行います。
使用方法
ts
await Hedgehog.user.ref("メールアドレス").updateToken();