LIFFアプリはどこで動く?実行環境ごとの挙動の違いを整理する
こんにちは!テクニカルサポートを担当している岡です。今回のTipsでは、LIFFの実行環境についてご紹介します。
LIFFアプリを開発していて、「手元のPCのブラウザでは動くのに、LINEアプリ上で開くと挙動が違う」と戸惑ったことはありませんか?
あるいは逆に、「LINEアプリ上では動くのに、外部ブラウザで開くとボタンが押せない」といった報告を受けたこともあるかもしれません。
LIFFアプリは複数の実行環境で動作するため、環境ごとの違いを理解しておくことが、安定したLIFFアプリ開発の第一歩です。
この記事では、実行環境の整理と、実装で必要となる分岐パターンを紹介します。
LIFFアプリが動く2つの実行環境
LIFFアプリの実行環境は、大きく次の2つに分けられます。
- LIFFブラウザ
- LIFFブラウザ以外:ChromeやSafariなどの外部ブラウザ、またはLINE内ブラウザ
「LINEアプリの中で開いているから同じ」と思われがちですが、LIFFブラウザとLINE内ブラウザは別物です。LIFFブラウザとLINE内ブラウザの違いについて、詳しくは「LIFFブラウザとLINE内ブラウザの違い」をご覧ください。
LIFFアプリがどの環境で動いているかはliff.isInClient()でわかる
現在の実行環境がLIFFブラウザかどうかは、liff.isInClient()で判定できます。
分岐パターンの考え方
上で紹介したliff.isInClient()メソッドを起点にして、ここから分岐パターンを組み立てていきましょう。
ログインフローの違い
LIFFブラウザでは、ユーザーはすでにLINEにログインした状態でLIFFアプリを開くため、明示的なログイン処理は不要です。
一方、LIFFブラウザ以外の場合では、liff.login()によるログイン処理が必要です。
なお、liff.init()のオプションwithLoginOnExternalBrowser: trueを以下のように指定すると、LIFFブラウザ以外の環境での初期化時にliff.login()を自動で実行できます。
また、LIFFブラウザ内で認可リクエストを直接行った場合の動作は保証されません。したがってログイン処理には、LINEログインの認可リクエストを直接実装するのではなく、必ずliff.login()を使用するようにしてください。
liff.closeWindow()はLIFFブラウザ以外では挙動が保証されない
「閉じる」ボタンでLIFFアプリを閉じる実装は定番ですが、liff.closeWindow()は、LIFFブラウザ以外での動作は保証対象外です。LIFFブラウザ以外でも表示される可能性のある画面では、別の動線を確保することを検討しましょう。
トークルームと連携する機能
liff.sendMessages()のように、LIFFアプリを開いているトークルームを前提とする機能は、LIFFブラウザでのみ利用できます。
トークルームの情報はliff.getContext()で取得できるため、コンテキストの有無に応じて機能の表示を切り替えるとよいでしょう。
このほかにも、APIごとに利用できる実行環境やOS、必要な権限は細かく異なります。実装前にLIFF APIリファレンスで対象APIの動作環境を確認する習慣をつけておくと、「この環境では動かない」とリリース後になって気づく事故を防げます。
まとめ
- LIFFアプリの実行環境は、大きく分けて「LIFFブラウザ」または「LIFFブラウザ以外(外部ブラウザ、LINE内ブラウザ)」の2つ
- 環境の判定には
liff.isInClient()を使用する - ログインフロー、
liff.closeWindow()、トークルーム連携機能は環境ごとの分岐が必要 - 迷ったらAPIリファレンスの動作環境欄を確認する
「検証環境では動くのに実機では動かない」という事象は、実行環境の違いが原因であることが少なくありません。ブラウザごとの特徴を押さえて、どの環境でも快適に動作するLIFFアプリを作りましょう。