opensocial.DataRequest¶

class opensocial.DataRequest()¶

メンバーのプロフィールやアクティビティなどの情報をSNSから取得するために使用します。 DataRequest オブジェクトの生成には opensocial.newDataRequest メソッドを使用して下さい。

これから新しくアプリを作成しようと考えている場合は、プロフィール等の取得に OSAPI の使用を検討してください。 OpenSocial v1.0 以降では DataRequest クラスを含む多くのクラス・メソッドが Deprecated とされています。

add()¶

opensocial.DataRequest.add(request, opt_key)¶

Arguments:	request (Object) – 実行するリクエスト opt_key (String) – リクエストの結果を取得するために使用するキー

DataRequest オブジェクトで実行するリクエストを追加します。これによってリクエストを複数まとめて実行することが可能です。 opt_key は各リクエストの結果を取得するためのキーとして使用します。

newCreateAlbumRequest()¶

opensocial.DataRequest.newCreateAlbumRequest(An, album)¶

Arguments:	An (opensocial.IdSpec) – アルバムを作成するメンバーまたはグループ album (opensocial.Album) – 作成するアルバム
Returns:	リクエストオブジェクト

実装されていません 新規にアルバムを作成します。

newCreateMediaItemRequest()¶

opensocial.DataRequest.newCreateMediaItemRequest(An, albumId, mediaItem)¶

Arguments:	An (opensocial.IdSpec) – アルバムを所有するメンバーまたはグループ albumId (String) – 追加先のアルバム mediaItem (opensocial.MediaItem) – 追加するアイテム
Returns:	リクエストオブジェクト

実装されていません アルバムにアイテムを追加します。

newDeleteAlbumRequest()¶

opensocial.DataRequest.newDeleteAlbumRequest(An, albumId)¶

Arguments:	An (opensocial.IdSpec) – アルバムを所有するメンバーまたはグループ albumId (String) – 削除するアルバム
Returns:	リクエストオブジェクト

実装されていません アルバムを削除します。

newFetchActivitiesRequest()¶

opensocial.DataRequest.newFetchActivitiesRequest(idSpec, opt_params)¶

Arguments:	idSpec (opensocial.IdSpec) – アクティビティを取得する対象 opt_params (Map.<opensocial.DataRequest.ActivityRequestFields\|Object>) – アクティビティ取得のためのオプション
Returns:	リクエストオブジェクト

アクティビティを取得します。

newFetchAlbumsRequest()¶

opensocial.DataRequest.newFetchAlbumsRequest(An, opt_params)¶

Arguments:	An (opensocial.IdSpec) – 取得するアルバムの所有者 opt_params (Map.<String\|String>) – アルバム取得のためのオプション
Returns:	リクエストオブジェクト

アルバムを取得します。

newFetchMediaItemsRequest()¶

opensocial.DataRequest.newFetchMediaItemsRequest(An, albumId, opt_params)¶

Arguments:	An (opensocial.IdSpec) – 取得する MediaItem の所有者 albumId (String) – 取得する MediaItem のアルバムID opt_params (Map.<String\|String>) – MediaItem 取得のためのオプション
Returns:	リクエストオブジェクト

アルバム内の MediaItem を取得します。

newFetchPeopleRequest()¶

opensocial.DataRequest.newFetchPeopleRequest(idSpec, opt_params)¶

Arguments:	idSpec (opensocial.IdSpec) – 取得するメンバー opt_params (Map.<opensocial.DataRequest.PeopleRequestFields\|Object>) – 取得時のオプション
Returns:	リクエストオブジェクト

Note

この処理は osapi.people.* で置き換え可能です。

メンバー情報の一覧を取得します。

newFetchPersonAppDataRequest()¶

opensocial.DataRequest.newFetchPersonAppDataRequest(idSpec, keys, opt_params)¶

Arguments:	idSpec (opensocial.IdSpec) – 取得する対象となるメンバー key (Array.<String> \| String) – 取得するデータのキー opt_params (Map.<opensocial.DataRequest.DataRequestFields\|Object>) – 取得時のオプション
Returns:	リクエストオブジェクト

Note

この処理は osapi.appdata.* で置き換え可能です。

アプリの保存しているデータを取得します。

newFetchPersonRequest()¶

opensocial.DataRequest.newFetchPersonRequest(id, opt_params)¶

Arguments:	id (String) – 取得するメンバーのID opt_params (Map.<opensocial.DataRequest.PeopleRequestFields\|Object>) – 取得時のオプション
Returns:	リクエストオブジェクト

Note

この処理は osapi.people.* で置き換え可能です。

メンバー情報を取得します。

newRemovePersonAppDataRequest()¶

opensocial.DataRequest.newRemovePersonAppDataRequest(keys)¶

Arguments:	keys (Array.<String> \| String) – 削除するデータのキー
Returns:	リクエストオブジェクト

Note

この処理は osapi.appdata.* で置き換え可能です。

アプリの保存しているデータを削除します。

newUpdateAlbumRequest()¶

opensocial.DataRequest.newUpdateAlbumRequest(An, albumId, fields)¶

Arguments:	An (opensocial.IdSpec) – アルバムの所有者 albumId (String) – アルバムID fields (Map<opensocial.Album.Field\|object>) – 更新するフィールドと値の組
Returns:	リクエストオブジェクト

実装されていません アルバムの情報を更新します。

newUpdateMediaItemRequest()¶

opensocial.DataRequest.newUpdateMediaItemRequest(An, albumId, mediaItemId, fields)¶

Arguments:	An (opensocial.IdSpec) – MediaItem の所有者 albumId (String) – アルバムID mediaItemId (String) – MediaItem のID fields (Map<opensocial.MediaItem.Field\|object>) – 更新するフィールドと値の組
Returns:	リクエストオブジェクト

実装されていません アルバムに含まれる MediaItem の情報を更新します。

newUpdatePersonAppDataRequest()¶

opensocial.DataRequest.newUpdatePersonAppDataRequest(key, value)¶

Arguments:	key (String) – 更新するデータのキー value (Object) – 更新後のデータ
Returns:	リクエストオブジェクト

Note

この処理は osapi.appdata.* で置き換え可能です。

アプリの保存しているデータを更新します。

send()¶

opensocial.DataRequest.send(opt_callback)¶

Arguments:	opt_callback (Function) – コールバック

add メソッドにより追加されたリクエストを実行し、 opt_callback に指定されたコールバック関数に結果を渡します。

opOpenSocialPlugin v1.2 documentation