opOpenSocialPlugin v1.2 documentation

ライフサイクルイベント

«  Gadget   ::   Contents   ::   軽量 JavaScript API  »

ライフサイクルイベント

ライフサイクルイベント とは、アプリに関する様々なイベントを、アプリ提供側に送る機能です。

現在の opOpenSocialPlugin では以下のイベントに対応しています。

宣言

ライフサイクルイベントを利用する場合はGadget XMLのModulePrefsタグ中に以下のような宣言をして下さい。

例:

<Link rel="event.addapp" href="http://example.com/add" method="POST" />
<Link rel="event.removeapp" href="http://example.com/remove" method="POST" />

属性は以下のようになります。

rel
利用者がアプリが追加されたときに発生する event.addapp と、利用者がアプリの使用を終了するために削除したときに発生する event.removeapp を利用することができます。(必須)
href
通知を受け付ける有効なURLを指定して下さい。(必須)
method
HTTPリクエスト種類 (GETかPOSTを選択。指定しない場合はGETになります。)

通知についての注意事項

ライフサイクルイベントは、イベント発生時に即時発行されるものではなく、SNS設置者が 設定 した間隔で通知されます。間隔や1度に通知される量についてはSNS設置者の告知を確認してください。

通知リクエストの内容

各イベント通知リクエストでは、Authorizationリクエストヘッダに 署名 が付加されます。第三者からの不正な通知を受け付けないために必ず署名の検証を行って下さい。

それぞれのイベントには以下のパラメータが付加されています。

event.addapp

eventtype
“event.addapp”固定
id
アプリの使用を開始したメンバーのID
from
アプリをどこから追加したか。ギャラリーから追加した場合”gallery”、招待されて追加した場合は”invite”
invite_from
招待されて追加した場合の招待者のメンバーID

event.removeapp

eventtype
“event.removeapp”固定。
id
アプリの使用を終了するために削除したメンバーのID

«  Gadget   ::   Contents   ::   軽量 JavaScript API  »