お気に入り | 日本語 | ログイン

opensocial.Activity.Field (v0.7)

 概要     詳細

Static Class opensocial.Activity.Field

Activity に含めることができるすべてのフィールドです。

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 のみです。追加のパラメータを無視するように指定することもできます。

関連項目: opensocial.Activity.getField()

フィールドの概要

<static> object APP_ID
このアクティビティが関連付けられているアプリケーションを指定する文字列です。
<static> object BODY

アクティビティの拡張版 (オプション) を指定する文字列です。

<static> object BODY_ID

ガジェット仕様でボディ テンプレート メッセージ ID を指定する文字列です。

<static> object EXTERNAL_ID
ポスト アプリケーションによって生成された文字列 ID (オプション) です。
<static> object ID
このアクティビティに永久に関連付けることができる文字列 ID です。
<static> object MEDIA_ITEMS
アクティビティに関連付ける必要のあるあらゆる写真、動画、画像です。
<static> object POSTED_TIME
このアクティビティが実行された時刻をエポック時刻からのミリ秒数で示す文字列です。
<static> object PRIORITY
同じソースの他のアクティビティに対するこのアクティビティの相対的な優先順位を表す 0 から 1 の間の数値です。
<static> object STREAM_FAVICON_URL
ストリームの favicon の URL を指定する文字列です。
<static> object STREAM_SOURCE_URL
ストリームのソース URL を指定する文字列です。
<static> object STREAM_TITLE
ストリームのタイトルを指定する文字列です。
<static> object STREAM_URL
ストリームの URL を指定する文字列です。
<static> object TEMPLATE_PARAMS

このアクティビティに関連付けられた値へのカスタム キーのマップです。

<static> object TITLE

アクティビティのプライマリ テキストを指定する文字列です。

<static> object TITLE_ID

ガジェット仕様でタイトル テンプレート メッセージ ID を指定する文字列です。

<static> object URL
このアクティビティを表す URL を指定する文字列です。
<static> object USER_ID
このアクティビティの対象ユーザーの文字列 ID です。
 

フィールドの詳細

APP_ID

<static> object APP_ID
    このアクティビティが関連付けられているアプリケーションを指定する文字列です。この値は設定できません。

BODY

<static> object BODY

    アクティビティの拡張版 (オプション) を指定する文字列です。

    ボディで使用できる HTML タグは <b>、<i>、<a>、<span> のみです。コンテナによっては、アクティビティをレンダリングするときに、このフォーマットが無視されることがあります。

BODY_ID

<static> object BODY_ID

    ガジェット仕様でボディ テンプレート メッセージ ID を指定する文字列です。

    ボディは、アクティビティの拡張版 (オプション)です。

    ボディで使用できる HTML タグは <b>、<i>、<a>、<span> のみです。コンテナによっては、アクティビティをレンダリングするときに、このフォーマットが無視されることがあります。

EXTERNAL_ID

<static> object EXTERNAL_ID
    ポスト アプリケーションによって生成された文字列 ID (オプション)です。

ID

<static> object ID
    このアクティビティに永久に関連付けることができる文字列 ID です。この値は設定できません。

MEDIA_ITEMS

<static> object MEDIA_ITEMS
    アクティビティに関連付ける必要のあるあらゆる写真、動画、画像です。リストは優先順位の順に並べられています。データのタイプは Array< MediaItem> です。

POSTED_TIME

<static> object POSTED_TIME
    このアクティビティが実行された時刻をエポック時刻からのミリ秒数で示す文字列です。この値は設定できません。

PRIORITY

<static> object PRIORITY
    同じソースの他のアクティビティに対するこのアクティビティの相対的な優先順位を表す 0 から 1 の間の数値です。

STREAM_FAVICON_URL

<static> object STREAM_FAVICON_URL
    ストリームの favicon の URL を指定する文字列です。

STREAM_SOURCE_URL

<static> object STREAM_SOURCE_URL
    ストリームのソース URL を指定する文字列です。

STREAM_TITLE

<static> object STREAM_TITLE
    ストリームのタイトルを指定する文字列です。

STREAM_URL

<static> object STREAM_URL
    ストリームの URL を指定する文字列です。

TEMPLATE_PARAMS

<static> object TEMPLATE_PARAMS

    このアクティビティに関連付けられた値へのカスタム キーのマップです。テンプレートで、これらの値が変数に代入されます。

    データのタイプは Map<String, Object> です。この Object は、文字列か opensocial.Person のいずれかです。

    キー PersonKey と共に Person を渡す場合は、テンプレートで次の置換変数を使用できます。

    • PersonKey.DisplayName - その個人の表示名
    • PersonKey.ProfileUrl - 個人のプロフィールの URL
    • PersonKey.Id - 個人の ID
    • PersonKey - コンテナにより DisplayName で置換されることがありますが、オプションでユーザーにリンクされることもあります。

TITLE

<static> object TITLE

    アクティビティのプライマリ テキストを指定する文字列です。

    タイトルで使える HTML タグは <b>、<i>、<a>、<span> のみです。コンテナによっては、アクティビティをレンダリングするときに、このフォーマットが無視されることがあります。

TITLE_ID

<static> object TITLE_ID

    ガジェット仕様でタイトル テンプレート メッセージ ID を指定する文字列です。

    タイトルは、アクティビティのプライマリ テキストです。

    タイトルで使える HTML タグは <b>、<i>、<a>、<span> のみです。コンテナによっては、アクティビティをレンダリングするときに、このフォーマットが無視されることがあります。

URL

<static> object URL
    このアクティビティを表す URL を指定する文字列です。

USER_ID

<static> object USER_ID
    このアクティビティの対象ユーザーの文字列 ID です。この値は設定できません。

このドキュメントは JsDoc Toolkit 1.3.3 で生成されました。