opensocial.*¶
opensocial.getEnvironment()¶
Returns: opensocial.Environment
アプリが実行されている環境の情報を取得します。サポートされているプロフィールのフィールドを調べる場合などに使用できます。詳しくは opensocial.Environment を参照して下さい。
opensocial.hasPermission()¶
Arguments: - permission (opensocial.Permission) – 確認する対象となるアクセス権
Returns: アクセス権を持っていれば true、そうでなければ false。
実装されていません 実行中のアプリが permission に対するアクセス権を持っているかどうかを調べます。
opensocial.invalidateCache()¶
実行中のアプリで VIEWER が現在までに生成したキャッシュを無効化します。このメソッドを実行するとそれ以前のキャッシュは使用されなくなります (キャッシュ機能自体が無効になるという意味ではありません)。
opensocial.requestPermission()¶
Arguments: - permissions (Array.<opensocial.Permission>) – 要求するアクセス権
- reason (String) – 要求する理由 (ユーザーに対して表示される)
- opt_callback (Function) – コールバック
実装されていません ユーザーに対して permission のアクセス権の許可を求めます。
opensocial.requestShareApp()¶
Arguments: - recipients (opensocial.IdSpec) – リクエストの送信先
- reason (opensocial.Message) – 実装されていません リクエストの送信理由 (ユーザーに対して表示される)
- opt_callback (Function) – コールバック
- opt_params (opensocial.NavigationParameters) – 実装されていません リクエストの作成時・承認時にユーザーを移動させるためのパラメータ
recipients で指定したユーザーにアプリを招待します。 recipients には IdSpec オブジェクト以外にも "VIEWER_FRIENDS" を指定することができます。
送信前に下図のような送信先の選択画面 (recipients に含まれるメンバーから送信先を選択できる) が表示されます。
コールバック関数の第一引数には opensocial.ResponseItem オブジェクトが渡されます。このオブジェクトの getData メソッドで、実際に招待が送信されたメンバーIDの配列を取得できます。また、重複送信などで誰にも招待が送られなかった場合は false が格納されます。
選択画面でユーザーが送信をキャンセルした場合でもコールバック関数が呼ばれます。これを区別するためにはコールバック関数内で hadError メソッドを使用してください。
使用例¶
opensocial.requestShareApp() を使用してアプリの招待を行う例:
opensocial.requestShareApp("VIEWER_FRIENDS", null, function (data) {
if (data.hadError()) return; // キャンセルされた等
var invited = data.getData();
if (invited === false) return; // 重複などで誰にも送信されなかった場合
alert(invited.length + " 人のメンバーを招待しました");
});
opensocial.newActivity()¶
Arguments: - params (Map.<opensocial.Activity.Field|Object>) – 作成するアクティビティのパラメータ
Returns:
新規に opensocial.Activity オブジェクトを作成します。パラメータに使用できるフィールドの一覧は opensocial.Activity.Field を参照して下さい。なお opensocial.Activity.Field.TITLE は必須フィールドとなっています。
作成したアクティビティをSNSへ送信するためにはさらに opensocial.requestCreateActivity を呼び出す必要があります。
opensocial.newAlbum()¶
Arguments: - opt_params (Map.<opensocial.Album.Field|Object>) – 作成するアルバムのパラメータ
Returns:
新規に opensocial.Album オブジェクトを作成します。パラメータに使用できるフィールドの一覧は opensocial.Album.Field を参照して下さい。
ただし、現バージョンの opOpenSocialPlugin はアルバムの作成に対応していないため、現時点では作成したオブジェクトを使うことができません。
opensocial.newDataRequest()¶
Returns: opensocial.DataRequest
Note
このメソッドの一部の処理は OSAPI を使用して置き換え可能です。
新規に opensocial.DataRequest オブジェクトを作成します。DataRequestを使用してSNSに対してリクエストを送信する場合は最初にこのメソッドを実行します。
opensocial.newIdSpec()¶
Arguments: - parameters (Map.<opensocial.IdSpec.Field|Object>) – 作成する IdSpec オブジェクトのパラメータ
Returns: opensocial.IdSpec
Note
メンバー情報の取得は osapi.people.* で置き換え可能です。
新規に opensocial.IdSpec オブジェクトを作成します。パラメータに使用できるフィールドは opensocial.IdSpec.Field を参照して下さい。
opensocial.newMediaItem()¶
Arguments: - mimeType (String) – メディアの MIME type
- url (String) – メディアのURL
- opt_params (Map.<opensocial.MediaItem.Field|Object>) – 作成するメディアのパラメータ
Returns:
新規に opensocial.MediaItem オブジェクトを作成します。パラメータに使用できるフィールドは opensocial.MediaItem.Field を参照して下さい。
opensocial.newMessage()¶
Arguments: - body (String) – 作成するメッセージの本文
- opt_params (Map.<opensocial.Message.Field|Object>) – 作成するメッセージのパラメータ
Returns: opensocial.Message
新規に opensocial.Message オブジェクトを作成します。パラメータに使用できるフィールドは opensocial.Message.Field を参照して下さい。
ただし、現バージョンの opOpenSocialPlugin はメッセージの送信に対応していないため、現時点では作成したオブジェクトを使うことができません。
opensocial.requestCreateActivity()¶
Arguments: - activity (opensocial.Activity) – 送信するアクティビティ
- priority (opensocial.CreateActivityPriority) – アクティビティの優先度
- opt_callback (Function) – コールバック
アクティビティを送信します。送信に使用する opensocial.Activity オブジェクトは opensocial.newActivity メソッドを使用して生成して下さい。
アクティビティに設定できる優先度は opensocial.CreateActivityPriority を参照して下さい。
opensocial.requestSendMessage()¶
Arguments: - An (opensocial.IdSpec) – メッセージの送信先
- message (opensocial.Message) – 送信するメッセージ
- opt_callback (Function) – コールバック
- opt_params (opensocial.NavigationParameters) – メッセージの作成時・承認時にユーザーを移動させるためのパラメータ
実装されていません メッセージを送信します。送信に使用する opensocial.Message オブジェクトは opensocial.newMessage メソッドを使用して生成して下さい。