URLスキームを利用したRayKitアプリの起動

「RayKit」アプリはURLスキームをサポートしています。URLスキームを使用すると、モバイルデバイスにインストールされている他のアプリ(ブラウザアプリなど)から「RayKit」アプリを起動でき、アプリの起動直後に表示するオブジェクトやページを指定することもできます。

前提

  • 「RayKit」アプリがモバイルデバイスにインストールされている必要があります。
  • URLスキームで指定したオブジェクトやページを「RayKit」アプリで表示するには、対象を参照できるアカウントで「RayKit」アプリにログインする必要があります。

URLスキームの指定方法

URLスキームは次のようにパラメータを指定します。

<scheme_name>://sObject/<id>/<action>
  • scheme_name:URLスキームで起動するアプリを指定します。「RayKit」アプリを起動する場合はraykitを指定します。
  • id:SalesforceのレコードIDを指定します。URLスキームで「RayKit」アプリを起動させたとき、ここで指定したIDのレコードを表示します。IDは15桁または18桁のどちらも指定できます。
  • action:URLスキームで「RayKit」アプリを起動させたときの動作を指定できます。指定できる動作は次の通りです。

    パラメータ 説明 書式
    view レコードの詳細ページを参照モードで表示します。 raykit://sObject/<レコードID>/view
    edit レコードの詳細ページを編集モードで表示します。 raykit://sObject/<レコードID>/edit
    home 指定したオブジェクトのホーム画面を表示します。 raykit://sObject/<オブジェクトのAPI参照名>/home

アプリの動作

URLスキームを使用したときの「RayKit」アプリの動作を説明します。ここでは、モバイルデバイスにインストールされているブラウザアプリからURLスキームをクリックしたときを例にして動作の説明をします。

URLスキームが書式通りに指定されていて、対象のレコードIDがSalesforceに存在する場合は、URLスキームのリンクをクリックすると「RayKit」アプリが起動して対象の画面が表示されます。

Salesforceに存在しないレコードIDまたはオブジェクトのAPI参照名を指定した場合は、次の画面が表示されます。

  • Selesforceに存在しないレコードIDを参照モードで指定した場合 存在しないレコードIDを参照モードで指定したとき

  • Selesforceに存在しないレコードIDを編集モードで指定した場合 存在しないレコードIDを編集モードで指定したとき

  • Selesforceに存在しないオブジェクトのAPI参照名を指定した場合 存在しないオブジェクトのAPI参照名を指定したとき

なお、「RayKit」アプリがモバイルデバイスにインストールされていない場合は、URLスキームをクリックしても何も発生せずにブラウザが表示されたままになります。

使用例: ブラウザにリンクを設定する

次のようにHTMLのページ内にリンクを作成し、モバイルデバイスにインストールされているブラウザアプリからリンクを開くと、「RayKit」アプリが起動して指定したレコードを表示します。

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta http-equiv="X-UA-Compatible" content="ie=edge">
    <title>ドキュメント</title>
</head>
<body>
    <a href="raykit://sObject/0036F00002cfB1F/view">取引先担当者レコード(ID 15桁)を参照モードで表示</a> <br>
    <a href="raykit://sObject/0016F00002SgFeHQAV/edit">取引先レコード(ID 18桁)を編集モードで表示</a> <br>
    <a href="raykit://sObject/Case/home">ケースのホーム画面を表示</a> <br>
    <a href="raykit://sObject/Opportunity/home">商談のホーム画面を表示</a> <br>
</body>
</html>
Copyright © 2019 GrapeCity inc. All rights reserved.