CustomJS API

CustomJS　APIで使用できる関数を記します。

仮想ページの作成

関数名:
sessionCamRecorder.createVirtualPageLoad（path）
戻り値：null
例：
sessionCamRecorder.createVirtualPageLoad(‘virtual/testpage’);
説明：レコーディングが有効な場合、現在のセッションに仮想ページを作成します。

仮想ページの終了

関数名:
sessionCamRecorder.closeVirtualPage（）
戻り値：null
説明：
現在の仮想ページを終了し、前のページとの記録を続けます。
これは、別の仮想ページ（createVirtualPageLoadへの複数の呼び出しが以前に行われた場合）または前の非仮想ページであってもよい。createVirtualPageへの複数の呼び出しでこれらのスタックが生成され、closeVirtualPageの各呼び出しで最後のものが削除され、残りのものが残ってメインページが再度アクティブになるまで、前のページが再アクティブ化されます。

closeVirtualPageが現在の仮想ページがないときに呼び出された場合、何もしません。
たとえば、SessionCamが存在しない場合などの潜在的なエラーを回避するには、メソッドを使用するときにチェックする必要があります

例：window.sessionCamRecorder.createVirtualPageLoad(‘newPageUrl’);
何らかの理由でタグが正しく起動せず、SessionCamが存在しない場合はエラーとなります。

if(window.sessionCamRecorder && window.sessionCamRecorder.createVirtualPageLoad)
window.sessionCamRecorder.createVirtualPageLoad(‘newPageUrl’);
それは何もしないので、そのような状況の下では安全であり、誤りではありません。

上記の関数のいずれかを使用する場合は、新しいページの一部であるDOMの変更を最初に行う必要があります。また、呼び出す前にこれらが有効であることを理想的にチェックして、新しいページはあなたが望む通りです。これを行う1つの方法は、jQuery関数自体を完了した後に実行され、SessionCamメソッドの呼び出しに使用できるコールバック関数を提供できるjQuery関数を利用することです。

たとえば、特定のメッセージが表示されている間に仮想ページを作成してから、それを後で削除するには、次のようなものを使用できます。

$(‘#message’).show(‘fast’, function() {
if(window.sessionCamRecorder && window.sessionCamRecorder.createVirtualPageLoad)
window.sessionCamRecorder.createVirtualPageLoad(‘message’);
});

ユーザーがメッセージを閉じるために何かをクリックすると、

$(‘#message’).hide(‘fast’, function() {
if(window.sessionCamRecorder && window.sessionCamRecorder.closeVirtualPage)
window.sessionCamRecorder.closeVirtualPage();
});

ユニークなGUIDを取得

関数名:
sessionCamRecorder.getSessionCamUserId()
戻り値：ホスト名を越えてユーザーを識別するguid、存在しない場合は空文字列、または内部問題がある場合はnull
説明：
guidが返された場合、その値が8760時間（1年間）に設定されたクッキー ‘sc.UserId’が作成され、クッキーが存在する場合は同じブラウザから同じ値が返されますクリアされません。

カスタムデータイベントを送信

関数名:
sessionCamRecorder.sendCustomDataEvent(key, value)
例：
sessionCamRecorder.sendCustomDataEvent(‘Message’, ‘Hello’);
戻り値：null
説明：
レコーディング中の場合、keyをelementId、値をデータとして使用してCustomDataEvent（code ‘tag’）型のイベントを生成して送信します。
調査設定が現在のページに存在し、調査が同じセッションの現在のページまたは前のページのいずれかにポップアップした場合、カスタムデータを調査ホストに送信します
上記のいずれかまたは両方は、該当する場合に発生する可能性があります。