GlassWare Timeline メソッド一覧


Google Developers Timelineの翻訳です。GlassWareにつかわれるTimelineのメソッドの一覧です。TimeLineはJSON形式で表します。

記述の仕方

[code]
{
"kind": "mirror#timelineItem",
"id": string,
"sourceItemId": string,
"canonicalUrl": string,
"bundleId": string,
"isBundleCover": boolean,
"selfLink": string,
"created": datetime,
"updated": datetime,
"displayTime": datetime,
"isPinned": boolean,
"pinScore": integer,
"isDeleted": boolean,
"etag": etag,
"creator": contacts Resource,
"recipients": [
contacts Resource
],
"inReplyTo": string,
"title": string,
"text": string,
"html": string,
"htmlPages": [
string
],
"speakableType": string,
"speakableText": string,
"attachments": [
timeline.attachments Resource
],
"location": locations Resource,
"menuItems": [
{
"id": string,
"action": string,
"values": [
{
"state": string,
"displayName": string,
"iconUrl": string
}
],
"removeWhenSelected": boolean,
"payload": string
}
],
"notification": {
"level": string,
"deliveryTime": datetime
}
}
[/code]

プロパティ名 説明 注釈  
種類 string リソースのタイプ。常に mirrot#timelineItem 。
id string タイムラインのアイテムのID。ユーザーのタイムライン内でユニークな値です。
sourceItemId string あなたの独自のサービスのデータにタイムラインのアイテムをマップするために使用する不透明なstring。 writable
canonicalUrl string タイムラインアイテムによって表されるデータの標準/高品質のバージョンを指すcanonicalURL。 writable
bundleId string アイテムのbundle ID。一緒に多くのアイテムをグループ化するbundleIdを指定することができます。デバイス上の単一のトップレベルのアイテムの下に表示されます。 writable
isBundleCover boolean アイテムは、バンドルカバーであるかどうか。アイテムがバンドルカバーとしてマークされている場合、それは同じbundleId持っているアイテムのバンドルへのエントリポイントになります。唯一のメインのタイムラインに表示されます- 開かれたバンドル内ではない。メインのタイムラインでは、示されているアイテムは次のとおりです。

  • trueと設定されたisBundleCoverのアイテム
  • bundleIdを持っていないアイテム

バンドルサブタイムラインで示されているアイテムは、次のとおりです。

  • falseと設定されたisBundleCoverAND bundleIdを持っているアイテム
writable
selfLink string アイテムを取得するために使用できるURL。
作成 datetime アイテムが作成された時刻(RFC 3339)。
更新した datetime アイテムが最後に変更された時刻(RFC 3339)
displayTime datetime アイテムがタイムラインで表示されたときに表示されるべきである時間(RFC 3339)。ユーザーのタイムラインは、表示時間に時系列にソートされているので、どこにアイテムがタイムラインに表示されるか決定します。設定されていない場合は、表示時間のデフォルト値は更新時間。 writable
isPinned boolean trueの場合には、アイテムにピンをうてます。タイムラインの非固定のアイテムから、ホーム画面の反対側に、ナビゲーションやハングアウトのような”アクティブ”のアイテムと一緒にグループ化され固定されてます。ユーザーが、このプロパティの値をTOGGLE_PINNED(ビルトインメニューアイテム)で交互に切り替えるようにすることができます。
pinScore integer 固定されたアイテムについては、時計の近くにが表示されるより高いスコアと、アイテムがタイムラインに表示される順序を決定します。注:このフィールドの設定は、現在サポートされていません。
isDeleted boolean trueの場合、このアイテムは削除されていることを示し、そして唯一のIDプロパティが設定されています。
etag etag アイテムのetag
creator nested object アイテムを作成したユーザーまたはグループ。 writable
recipients[] list アイテムに共有されているユーザーまたはグループのlist。 writable
inReplyTo string このアイテムが他のアイテムへの返信として生成された場合、このフィールドは返信されているアイテムのIDを設定します。適切な会話またはポストへの返信を取り付けるために使用することができます。
タイトル string アイテムのタイトル。 writable
テキスト string アイテムのテキストの内容。 writable
html string アイテムのhtmlコンテンツ。もしテキストとhtml文両方の場合、html文がタイムライン上でレンダリングされます。

使用可能なhtmlの要素 -タイムラインカードで、これらの要素を使用することができます。

  • ヘッダー:H1、H2、H3、H4、H5、H6
  • 画像:IMG
  • list:OL、li、UL
  • HTML5セマンティクス:article, aside, details, figure, figcaption, footer, header, nav, section, summary, time
  • 構造:blockquote, br, div, hr, p, span
  • スタイル: b, big, center, em, i, u, s, small, strike, strong, style, sub, sup
  • テーブル:table, tbody, td, tfoot, th, thead, tr

ブロックされるHTMLの要素HTMLペイロードからこれらの要素とその内容が削除されます。

  • 文書ヘッダ: head, title
  • 埋め込み: audio, embed, object, source, video
  • フレーム:frame, frameset
  • スクリプティング:applet, script

他の要素:listされていないすべての要素が削除されますが、その内容は保持されます。

writable
htmlPages [] list このフィールドは廃止され、ページネーションを代わりにHTMLのプロパティを使用 writable
speakableText string アイテムの内容を話す内容。メニューアイテムの「READ_ALOUD」に沿って、明確に読み上げるためのテキストを提供したり、Google Glassに視覚的に表示されているものに拡張情報を提供するためにこのフィールドを使用します。GlasWareでもspeakableTypeフィールドを指定する必要があります。 例えば、ユーザーが通知後に読み上げすることを要求するあど追加のコンテキストが、有用である場合、テキストの前に話される。

writable
attachments[] list アイテムに関連付けられたメディア添付ファイルのリスト。添付ファイルまたはCID スキームを使用してHTMLペイロードに含まれる添付ファイルを参照することができます。たとえば、次のように
  • 添付ファイル:<img src=”attachment:attachment_index”> attachment_indexは配列の0から始まるインデックスです。
  • CID:<img src=”cid:attachment_id”> attachment_idは添付ファイルのIDです。
nested object ネストされたオブジェクト アイテムに関連付けられた地理的位置。 writable
menuItems[] list アイテムがタイムラインが選択された場合、ユーザに提示されるメニューアイテムのlist。 writable
menuItems[].id string メニューアイテムのID。アプリケーションによって生成され、不透明トークンとして扱われる。 writable
menuItems.action string ユーザがメニューオプションを選択したときの動作を制御します。許可された値は次のとおりです。
  • CUSTOM -アクションをカスタムに設定する。ユーザがこのmenuitemを選択したときに、APIは、このメニューアイテムのCUSTOM userActions.type、ID userActions.payloadと一緒にcallbackUrlへ通知します。これはデフォルト値です。
  • 組み込みアクション:
    • REPLY -音声録音UIを使用してタイムラインのアイテムへの返信を初期値にセットします。creator属性が利用できるように、このメニューのためにタイムラインアイテムに設定する必要があります。
    • REPLY_ALL -REPLYと同じような動作。オリジナルのタイムラインアイテムのrecipientsは返信アイテムに追加されます。
    • DELETE -タイムラインのアイテムを削除します。
    • SHARE -利用可能な連絡先とタイムラインのアイテムを共有します。
    • READ_ALOUD -タイムラインのアイテムのspeakableTextを声を出して読み上げます。このフィールドが設定されていない場合、これらのフィールドのいずれも設定されていない場合、このメニューアイテムは無視されます。
    • VOICE_CALL -タイムラインのアイテムのcreator.phone_numberを使って電話をかけるます。
    • NAVIGATE -タイムラインのアイテムの場所にナビゲートします。
    • TOGGLE_PINNED -タイムラインのアイテムをisPinnedに切り替えます。
    • VIEW_WEBSITE -ブラウザにメニューアイテムのペイロードを開きます。
    • PLAY_VIDEO -Glassのビデオプレーヤーにメニューアイテムのペイロードを開きます
writable
menuItems.values[] list CUSTOMアイテム用。それぞれの状態のメニューアイテムの外観を制御する値のlist。DEFAULTの状態を提供する必要があります。PENDINGまたはCONFIRMED状態でない場合、それらは表示されません。 writable
menuItems.values.displayName[] string メニューアイテムに表示する名前。ビルトインのメニューアイテムのプロパティ指定した場合は、デフォルトのコンテキスト音声コマンドは表示されません。 writable
menuItems.values.iconUrl[] string メニューアイテムに表示するアイコンのURL。 writable
menuItems.values.state[] string この値が適用される状態。許可された値は次のとおりです。
  • DEFAULT -ニューアイテムのlistに表示されるデフォルト値。
  • PENDING -menuItemがユーザーによって選択されている時に表示される値、キャンセルすることができます。
  • CONFIRMED -menuItemがユーザによって選択された時に表示される値、もはやキャンセルすることができません。
writable
menuItems.removeWhenSelected[] boolean CUSTOMメニューアイテムにおいてtrueに設定した場合、そのアイテムは、選択された後にメニューから削除されます。 writable
notification nested object アイテムの通知がデバイス上に提示される方法を制御します。存在しない場合、通知は生成されません。 writable
notification.level string 通知がいかに重要であるかを説明します。許可された値は次のとおりです。
  • DEFAULT -デフォルトの重要な通知。ユーザーに警告するために再生されるチャイム。
writable
notification.deliveryTime datetime 通知が配信されるべき時刻。 writable
speakableType string アイテムのタイプの読み上げするための記述です。アイテムの内容を読む前にユーザーにアナウンスされます。アイテムが通知後に声に出して読まれることをユーザーに要求します。これは、このような短い、簡単で短いフレーズでなければなりません。”電子メール”、 “テキストメッセージ”、または”デイリープラネットニュース更新”。GlassWareは、すべてのタイムラインのアイテムに対しては、このフィールドを導入することが奨励されます。speakableTextまたはテキストが含まれていない場合でも、ユーザーは画面を見ずにアイテムの種類がわかります。

writable
menuItems.payload[] string MenuItemの行動に応じて変化する汎用ペイロード。
  • アクションが「VIEW_WEBSITE」の場合、ペイロードは、表示するWebサイトのURLです。
  • アクションが「PLAY_VIDEO」の場合、ペイロードはビデオのストリーミングURLである
writable

コメントを残す