トークンの更新とセッションの期限切れ
新しいトークンを受け取る
トークンは短期トークンで、新しいトークンはLXPだけが発行します。
- LXPは期限が切れる前に、iframe URLのフラグメントだけを変えて(
#token=…&baseUrl=…)新しいトークンを渡します。 - コンテンツは再読み込みされず、その中で
hashchangeが発生します。 - SDKは次の呼び出しから新しいトークンを使い、アドレスバーから
tokenを削除します。資料は再読み込みしません。
SDKがサーバーにトークンの更新をリクエストすることはありません。トークンが変わったことを知る必要がある場合(例:動画プレーヤー)は、sdk.onAccessTokenChange(listener)を使います。
ハッシュルーティングを使うコンテンツ
新しいトークンが届くと、コンテンツのハッシュはLXPが渡した値(tokenを削除した後、例:#baseUrl=…)に変わります。SDKはtokenのないhashchangeを無視するため、コンテンツはそのようなものだけを自分のものとして扱えば十分です。
- 編集ページでトークンを使って開いたプレビュー(
#token=…&preview=1、versionIdがあっても)も、同じ方法で新しいトークンを受け取ります。 - トークンのないプレビュー(
#preview=1、#edit=1)には、置き換えるトークンがありません。
セッションの期限切れ
新しいトークンが届く前にトークンが期限切れになるか、サーバーがセッションを終了すると、セッションが終了します。このとき、コンテンツは「再読み込みしてください」と案内するだけで十分です。
const sdk = new EliceCDK({
onSessionExpired: () => {
alertBanner('학습 시간이 길어졌어요. 페이지를 새로고침해 주세요.');
},
});
- セッションが終了すると
sdk.isSessionExpiredがtrueになり、以降のすべての呼び出しがsession_expiredで失敗します。 - トークンの期限切れで終了したセッションは、その後新しいトークンが届けば再開されます。
- 新しいトークンなしでトークンが期限切れになると、SDKは表示元のページに
status(failed、reason: 'auth')も送信します(読み込み状態)。 onSessionExpiredの中では、sandboxのためalertを使えません。画面の中に案内を表示します。
後処理
コンテンツを閉じるときは、sdk.dispose()で期限切れタイマーと新しいトークンの受け取りを停止します。