概要

このモジュール中の機能はMobage Open Platformが提供するTextData APIをJavaScriptから呼び出す為の機能が含まれています。
TextData API の詳細や使い方に関しては以下の各ドキュメントをご参照ください。 

• TextData APIの使い方 
• 自由文の入力・表示をする 

機能一覧

• メソッド
  • mbga.TextData.getId
  • mbga.TextData.getData
  • mbga.TextData.getStatus
  • mbga.TextData.getWriterId
  • mbga.TextData.getOwnerId
  • mbga.TextData.getField
  • mbga.TextData.setField
• mbga.TextData.Field
  • mbga.TextData.Field.ID
  • mbga.TextData.Field.GROUP_NAME
  • mbga.TextData.Field.PARENT_ID
  • mbga.TextData.Field.WRITER_ID
  • mbga.TextData.Field.OWNER_ID
  • mbga.TextData.Field.DATA
  • mbga.TextData.Field.STATUS
  • mbga.TextData.Field.PUBLISHED
  • mbga.TextData.Field.UPDATED
• mbga.TextDataRequestFields
  • mbga.TextDataRequestFields.TEXTDATA_ID
  • mbga.TextDataRequestFields.TEXTDATA_GROUP_NAME
  • mbga.TextDataRequestFields.TEXTDATA
  • mbga.TextDataRequestFields.SORT_BY
  • mbga.TextDataRequestFields.SORT_ORDER
  • mbga.TextDataRequestFields.FILTER_BY
  • mbga.TextDataRequestFields.FILTER_VALUE
  • mbga.TextDataRequestFields.FILTER_OP
  • mbga.TextDataRequestFields.FIRST
  • mbga.TextDataRequestFields.MAX
  • mbga.TextDataRequestFields.FORMAT
  • mbga.TextDataRequestFields.FIELDS
• mbga.TextDataRequest.SortBy
  • mbga.TextDataRequest.SortBy.ID
  • mbga.TextDataRequest.SortBy.UPDATED
• mbga.TextDataRequest.SortOrder
  • mbga.TextDataRequest.SortOrder.ASCENDING
  • mbga.TextDataRequest.SortOrder.DESCENDING
• mbga.TextDataRequest.FilterBy
  • mbga.TextDataRequest.FilterBy.OWNER_ID
  • mbga.TextDataRequest.FilterBy.WRITER_ID
• mbga.TextDataRequest.FilterOp
  • mbga.TextDataRequest.FilterOp.EQUALS
• mbga.TextDataRequest.Format
  • mbga.TextDataRequest.Format.JSON

メソッド

mbga.TextData.getId

mbga.TextData.getData

mbga.TextData.getStatus

mbga.TextData.getWriterId

mbga.TextData.getOwnerId

mbga.TextData.getField

mbga.TextData.setField

mbga.TextData.Field

mbga.TextData.Field.ID

テキストデータのID。

mbga.TextData.Field.GROUP_NAME

テキストデータグループの名前。

mbga.TextData.Field.PARENT_ID

親となるテキストデータのID。

mbga.TextData.Field.WRITER_ID

このテキストデータを書き込んだユーザのID。

mbga.TextData.Field.OWNER_ID

このテキストデータの所有者のID。

mbga.TextData.Field.DATA

テキストデータの本文。

mbga.TextData.Field.STATUS

テキストデータの論理ステータス値。以下は整数値とステータス内容の対応表です。

mbga.TextData.Field.PUBLISHED

テキストデータが生成された日時。

mbga.TextData.Field.UPDATED

テキストデータが更新された日時。

mbga.TextDataRequestFields

mbga.newFetchTextDataRequest, mbga.requestFetchTextData の opt_params で用いる事の出来るフィールド一覧です。

mbga.TextDataRequestFields.TEXTDATA_ID

更新/削除するTextDataのIDを指定します。

mbga.TextDataRequestFields.TEXTDATA_GROUP_NAME

TextDataのグループ名を指定します。

mbga.TextDataRequestFields.TEXTDATA

新規作成/更新するTextDataのデータを指定します。

mbga.TextDataRequestFields.SORT_BY

mbga.TextDataRequest.SortByのうちから指定できます。以下のサンプルでは、更新日時の降順（最新のものから順番に）にソートしたtextdataを取得します。

サンプル

mbga.TextDataRequestFields.SORT_ORDER

mbga.TextData.SortOrderのうちから指定できます。

mbga.TextDataRequestFields.FILTER_BY

mbga.TextDataRequest.FilterByが指定できます。

mbga.TextDataRequestFields.FILTER_VALUE

フィルタリングに用いるフィールド。OWNER_IDの値またはWRITER_IDの値が指定できます。以下のサンプルでは、OWNER_IDが"10000"であるtextdataのみを取得します。

サンプル

mbga.TextDataRequestFields.FILTER_OP

mbga.TextDataRequest.FilterOpが指定できます。

mbga.TextDataRequestFields.FIRST

textdata取得の開始位置を自然数で指定します。通常、mbga.TextDataRequestFields.MAXと同時に取得するデータのページングに用いられます。デフォルトの値は1です。

以下のサンプルでは取得するblacklistデータを5つずつのページに分けた上で、先頭から3番目のページとなる5つ分のデータを取得します。なお、該当するページに指定した数のデータが存在しなかった場合は返せる分だけのデータが取得されます。

サンプル

mbga.TextDataRequestFields.MAX

textdata取得の最大数を自然数で指定します。通常、mbga.TextDataRequestFields.FIRSTと同時に取得するデータのページングに用いられます。デフォルトの値は50です。

mbga.TextDataRequestFields.FORMAT

mbga.TextDataRequest.Format が指定できます

mbga.TextDataRequestFields.FIELDS

mbga.TextData.Fieldsのうちから獲得したいフィールドを並べた配列を指定します。

mbga.TextDataRequest.SortBy

mbga.TextDataRequest.SortBy.ID

mbga.TextData.Field.IDの値をキーとしてソートを行ないます。

mbga.TextDataRequest.SortBy.UPDATED

mbga.TextData.Field.UPDATEDの値をキーとしてソートを行ないます。

mbga.TextDataRequest.SortOrder

mbga.TextDataRequest.SortOrder.ASCENDING

キーとなる値の昇順にソートを行ないます。

mbga.TextDataRequest.SortOrder.DESCENDING

キーとなる値の降順にソートを行ないます。

mbga.TextDataRequest.FilterBy

mbga.TextDataRequest.FilterBy.OWNER_ID

mbga.TextData.Field.OWNER_IDの値でフィルタリングを行ないます。

mbga.TextDataRequest.FilterBy.WRITER_ID

mbga.TextData.Field.WRITER_IDの値でフィルタリングを行ないます。

mbga.TextDataRequest.FilterOp

mbga.TextDataRequest.FilterOp.EQUALS

フィルタリングを行う条件を、mbga.TextDataRequestFields.FILTER_VALUEで指定した値と等値」にします。

mbga.TextDataRequest.Format

mbga.TextDataRequest.Format.JSON

更新履歴

• 2015/10/08
  • TextData API の概要を追加
• 2012/06/05
  
  • TextData.Field.STATUS 削除フィールド値を削除