opensocial (v0.7)

 概要     詳細

Static Class opensocial

トップレベル関数群の名前空間です。

メソッドの概要

<static>  opensocial.Environment getEnvironment()

このガジェットの現在の環境を取得します。

<static>  Boolean hasPermission(permission)

指定した許可へのアクセス権が現在のガジェットに付与されている場合は true を返します。

<static>  opensocial.Activity newActivity(params)

サーバー上のアクティビティを表すアクティビティ オブジェクトを作成します。

<static>  opensocial.Activity.MediaItem newActivityMediaItem(mimeType, url, opt_params)

アクティビティに関連付けるメディア アイテムを作成します。

<static>  opensocial.DataRequest newDataRequest()

サーバーからのデータの送信やフェッチに使用するデータ要求オブジェクトを作成します。

<static>  opensocial.Message newMessage(body, opt_params)

アクティビティに関連付けるメッセージを作成します。

<static> requestCreateActivity(activity, priority, opt_callback)

指定したアクティビティの作成を、操作の完了を待たずに試行します。

<static> requestPermission(permissions, reason, opt_callback)

指定した許可へのアクセス権を付与するよう、ユーザーに要求します。

<static> requestSendMessage(recipients, message, opt_callback)

指定したユーザーに対して特定のメッセージを送信するよう、コンテナに要求します。

<static> requestShareApp(recipients, reason, opt_callback)

指定したユーザーとこのガジェットを共有するよう、コンテナに要求します。

 

メソッドの詳細

getEnvironment

<static> opensocial.Environment getEnvironment()

このガジェットの現在の環境を取得します。この環境を使用して、このコンテナでどのプロファイル フィールドやサーフェスがサポートされるか、現在のガジェットにどのパラメータが渡されたか、などの情報を照会できます。

戻り値:
opensocial.Environment 現在の環境

hasPermission

<static> Boolean hasPermission(permission)

指定した許可へのアクセス権が現在のガジェットに付与されている場合は true を返します。ガジェットが opensocial.requestPermission を呼び出して許可が付与された後は、この関数のすべての呼び出しに対して必ず true が返されます。

パラメータ:
opensocial.Permission permission - 許可です。

戻り値:
Boolean この許可へのアクセス権がガジェットに付与されている場合は true、付与されていない場合は false

newActivity

<static> opensocial.Activity newActivity(params)

サーバー上のアクティビティを表すアクティビティ オブジェクトを作成します。

関連項目: reque tCreateActivity()

TITLE_ID または TITLE のどちらかを設定することのみ必須です。ただし、タイトルやタイトル テンプレートで変数を使用している場合は、TEMPLATE_PARAMS も設定する必要があります。

これら以外に設定可能なフィールドは、URL、MEDIA_ITEMS、BODY_ID、BODY、 EXTERNAL_ID、PRIORITY、STREAM_TITLE、STREAM_URL、STREAM_SOURCE_URL、および STREAM_FAVICON_URL です。

コンテナで使用する必要があるのは、TITLE_ID または TITLE のみです。追加のパラメータを無視するように指定することもできます。

サポートされるフィールドの詳細については、Field をご覧ください。

パラメータ:
Map.<opensocial.Activity.Field, Object> params - アクティビティを定義するパラメータです。

戻り値:
opensocial.Activity 新しい Activity オブジェクト

newActivityMediaItem

<static> opensocial.Activity.MediaItem newActivityMediaItem(mimeType, url, opt_params)

アクティビティに関連付けるメディア アイテムを作成します。画像、動画、およびオーディオを表します。サーバー上のアクティビティを作成する際に使用します。

パラメータ:
String mimeType - メディアの MIME タイプです。
String url - メディアの格納場所です。
Map.<opensocial.Activity.MediaItem.Field, Object> opt_params - メディア アイテム オブジェクトに設定する必要のあるその他のフィールド。定義済みの Field はすべてサポートされます。

戻り値:
opensocial.Activity.MediaItem 新しい MediaItem オブジェクト

newDataRequest

<static> opensocial.DataRequest newDataRequest()

サーバーからのデータの送信やフェッチに使用するデータ要求オブジェクトを作成します。

戻り値:
opensocial.DataRequest Request オブジェクト

newMessage

<static> opensocial.Message newMessage(body, opt_params)

アクティビティに関連付けるメディア アイテムを作成します。画像、動画、およびオーディオを表します。サーバー上のアクティビティを作成する際に使用します。

パラメータ:
String body - メッセージの主文です。
Map.<opensocial.Message.Field, Object> opt_params - メッセージ オブジェクトに設定する必要のあるその他のフィールド。定義済みの Field はすべてサポートされます。

戻り値:
opensocial.Message 新しい Message オブジェクト

requestCreateActivity

<static> requestCreateActivity(activity, priority, opt_callback)

指定されたアクティビティの作成を、操作の完了を待たずに試行します。オプションとして、操作の完了時に関数を呼び出すこともできます。

関連項目: newActivity()

注: これがそのユーザー用に初めて作成されたアクティビティで、アクティビティ作成要求に HIGH が割り当てられている場合、この呼び出しによってユーザー フローが開かれ、現在のガジェットから移動することになる可能性があります。コンテナでこのメソッドがサポートされていない場合は、パラメータとして opensocial.ResponseItem を取るコールバックが呼び出されます。この応答アイテムにはエラー コードがあり、NOT_IMPLEMENTED に設定されます。

パラメータ:
opensocial.Activity activity - 作成するアクティビティです。
opensocial.CreateActivityPriority priority - この要求の優先度です。
Function opt_callback - 要求の処理が完了したときに呼び出す関数です。この関数が呼び出されるか、ガジェットが最初からロードし直されます。この関数は、1 つのパラメータ opensocial.ResponseItem を取ります。要求に問題があったかどうかに応じて、エラー コードが設定されます。エラーがなかった場合は、アクティビティが作成されます。エラーがあった場合は、応答アイテムの getErrorCode メソッドを使用して、どのように対処するかを判断できます。応答アイテムのデータは設定されません。

requestPermission

<static> requestPermission(permissions, reason, opt_callback)

指定した許可へのアクセス権を付与するようユーザーに要求します。コンテナでこのメソッドがサポートされていない場合は、パラメータとして opensocial.ResponseItem を取るコールバックが呼び出されます。この応答アイテムにはエラー コードがあり、NOT_IMPLEMENTED に設定されます。

パラメータ:
Array.<opensocial.Permission> permissions - ビューアから要求に対して付与される許可です。
String reason - これらの許可が必要となる理由をユーザーに説明する文字列です。
Function opt_callback - 要求の処理が完了したときに呼び出す関数。この関数が呼び出されるか、ガジェットが最初から再ロードされます。この関数は、1 つのパラメータ opensocial.ResponseItem を取ります。要求に問題があったかどうかに応じて、エラー コードが設定されます。エラーがなかった場合は、すべての許可が付与されます。エラーがあった場合は、opensocial.hasPermission を使用して、どの許可がまだ拒否されているかを確認できます。応答アイテムのデータが設定されます。このデータは、付与された opensocial.Permissions の配列です。

requestSendMessage

<static> requestSendMessage(recipients, message, opt_callback)

指定したユーザーに対して特定のメッセージを送信するよう、コンテナに要求します。コンテナでこのメソッドがサポートされていない場合は、パラメータとして opensocial.ResponseItem を取るコールバックが呼び出されます。この応答アイテムにはエラー コードがあり、NOT_IMPLEMENTED に設定されます。

パラメータ:
Array.<String>, String recipients - ID、ID の配列、またはグループ参照。サポートされるキーは、VIEWER、OWNER、VIEWER_FRIENDS、OWNER_FRIENDS、またはこれらのグループのいずれかに含まれている単一の ID です。
opensocial.Message message - 指定したユーザーに送信するメッセージです。
Function opt_callback - 要求の処理が完了したときに呼び出す関数です。この関数が呼び出されるか、ガジェットが最初からロードし直されます。この関数は、1 つのパラメータ opensocial.ResponseItem を取ります。要求に問題があったかどうかに応じて、エラー コードが設定されます。エラーがなかった場合は、メッセージが送信されます。エラーがあった場合は、応答アイテムの getErrorCode メソッドを使用して、どのように対処するかを判断できます。応答アイテムのデータは設定されません。

requestShareApp

<static> requestShareApp(recipients, reason, opt_callback)

指定したユーザーとこのガジェットを共有するよう、コンテナに要求します。コンテナでこのメソッドがサポートされていない場合は、パラメータとして opensocial.ResponseItem を取るコールバックが呼び出されます。この応答アイテムにはエラー コードがあり、NOT_IMPLEMENTED に設定されます。

パラメータ:
Array.<String>, String recipients - ID、ID の配列、またはグループ参照。サポートされるキーは、VIEWER、OWNER、VIEWER_FRIENDS、OWNER_FRIENDS、またはこれらのグループのいずれかに含まれている単一の ID です。
opensocial.Message reason - ユーザーがガジェット自体の共有を必要とする理由です。この理由は、コンテナがアプリケーションの共有の許可をユーザーに求める際に使用できます。これを無視することも可能です。
Function opt_callback - 要求の処理が完了したときに呼び出す関数です。この関数が呼び出されるか、ガジェットが最初からロードし直されます。この関数は、1 つのパラメータ opensocial.ResponseItem を取ります。要求に問題があったかどうかに応じて、エラー コードが設定されます。エラーがなかった場合は、共有の要求が送信されます。エラーがあった場合は、応答アイテムの getErrorCode メソッドを使用して、どのように対処するかを判断できます。応答アイテムのデータは設定されません。

---