1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="mirror_v1.html">Google Mirror API</a> . <a href="mirror_v1.timeline.html">timeline</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="mirror_v1.timeline.attachments.html">attachments()</a></code> 79</p> 80<p class="firstline">Returns the attachments Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="#delete">delete(id)</a></code></p> 84<p class="firstline">Deletes a timeline item.</p> 85<p class="toc_element"> 86 <code><a href="#get">get(id)</a></code></p> 87<p class="firstline">Gets a single timeline item by ID.</p> 88<p class="toc_element"> 89 <code><a href="#insert">insert(body=None, media_body=None, media_mime_type=None)</a></code></p> 90<p class="firstline">Inserts a new item into the timeline.</p> 91<p class="toc_element"> 92 <code><a href="#list">list(orderBy=None, includeDeleted=None, pageToken=None, maxResults=None, pinnedOnly=None, sourceItemId=None, bundleId=None)</a></code></p> 93<p class="firstline">Retrieves a list of timeline items for the authenticated user.</p> 94<p class="toc_element"> 95 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 96<p class="firstline">Retrieves the next page of results.</p> 97<p class="toc_element"> 98 <code><a href="#patch">patch(id, body)</a></code></p> 99<p class="firstline">Updates a timeline item in place. This method supports patch semantics.</p> 100<p class="toc_element"> 101 <code><a href="#update">update(id, body=None, media_body=None, media_mime_type=None)</a></code></p> 102<p class="firstline">Updates a timeline item in place.</p> 103<h3>Method Details</h3> 104<div class="method"> 105 <code class="details" id="delete">delete(id)</code> 106 <pre>Deletes a timeline item. 107 108Args: 109 id: string, The ID of the timeline item. (required) 110</pre> 111</div> 112 113<div class="method"> 114 <code class="details" id="get">get(id)</code> 115 <pre>Gets a single timeline item by ID. 116 117Args: 118 id: string, The ID of the timeline item. (required) 119 120Returns: 121 An object of the form: 122 123 { # Each item in the user's timeline is represented as a TimelineItem JSON structure, described below. 124 "attachments": [ # A list of media attachments associated with this item. As a convenience, you can refer to attachments in your HTML payloads with the attachment or cid scheme. For example: 125 # - attachment: <img src="attachment:attachment_index"> where attachment_index is the 0-based index of this array. 126 # - cid: <img src="cid:attachment_id"> where attachment_id is the ID of the attachment. 127 { # Represents media content, such as a photo, that can be attached to a timeline item. 128 "contentUrl": "A String", # The URL for the content. 129 "contentType": "A String", # The MIME type of the attachment. 130 "id": "A String", # The ID of the attachment. 131 "isProcessingContent": True or False, # Indicates that the contentUrl is not available because the attachment content is still being processed. If the caller wishes to retrieve the content, it should try again later. 132 }, 133 ], 134 "displayTime": "A String", # The time that should be displayed when this item is viewed in the timeline, formatted according to RFC 3339. This user's timeline is sorted chronologically on display time, so this will also determine where the item is displayed in the timeline. If not set by the service, the display time defaults to the updated time. 135 "creator": { # A person or group that can be used as a creator or a contact. # The user or group that created this item. 136 "kind": "mirror#contact", # The type of resource. This is always mirror#contact. 137 "displayName": "A String", # The name to display for this contact. 138 "acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items. 139 "A String", 140 ], 141 "imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client. 142 "A String", 143 ], 144 "priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities. 145 "source": "A String", # The ID of the application that created this contact. This is populated by the API 146 "phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number. 147 "sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are: 148 # - ADD_CAPTION 149 "A String", 150 ], 151 "type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are: 152 # - INDIVIDUAL - Represents a single person. This is the default. 153 # - GROUP - Represents more than a single person. 154 "acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command. 155 { # A single menu command that is part of a Contact. 156 "type": "A String", # The type of operation this command corresponds to. Allowed values are: 157 # - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command. 158 # - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command. 159 }, 160 ], 161 "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token. 162 "speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic. 163 }, 164 "text": "A String", # Text content of this item. 165 "menuItems": [ # A list of menu items that will be presented to the user when this item is selected in the timeline. 166 { # A custom menu item that can be presented to the user by a timeline item. 167 "contextual_command": "A String", # The ContextualMenus.Command associated with this MenuItem (e.g. READ_ALOUD). The voice label for this command will be displayed in the voice menu and the touch label will be displayed in the touch menu. Note that the default menu value's display name will be overriden if you specify this property. Values that do not correspond to a ContextualMenus.Command name will be ignored. 168 "removeWhenSelected": True or False, # If set to true on a CUSTOM menu item, that item will be removed from the menu after it is selected. 169 "payload": "A String", # A generic payload whose meaning changes depending on this MenuItem's action. 170 # - When the action is OPEN_URI, the payload is the URL of the website to view. 171 # - When the action is PLAY_VIDEO, the payload is the streaming URL of the video 172 # - When the action is GET_MEDIA_INPUT, the payload is the text transcription of a user's speech input 173 "values": [ # For CUSTOM items, a list of values controlling the appearance of the menu item in each of its states. A value for the DEFAULT state must be provided. If the PENDING or CONFIRMED states are missing, they will not be shown. 174 { # A single value that is part of a MenuItem. 175 "iconUrl": "A String", # URL of an icon to display with the menu item. 176 "state": "A String", # The state that this value applies to. Allowed values are: 177 # - DEFAULT - Default value shown when displayed in the menuItems list. 178 # - PENDING - Value shown when the menuItem has been selected by the user but can still be cancelled. 179 # - CONFIRMED - Value shown when the menuItem has been selected by the user and can no longer be cancelled. 180 "displayName": "A String", # The name to display for the menu item. If you specify this property for a built-in menu item, the default contextual voice command for that menu item is not shown. 181 }, 182 ], 183 "action": "A String", # Controls the behavior when the user picks the menu option. Allowed values are: 184 # - CUSTOM - Custom action set by the service. When the user selects this menuItem, the API triggers a notification to your callbackUrl with the userActions.type set to CUSTOM and the userActions.payload set to the ID of this menu item. This is the default value. 185 # - Built-in actions: 186 # - REPLY - Initiate a reply to the timeline item using the voice recording UI. The creator attribute must be set in the timeline item for this menu to be available. 187 # - REPLY_ALL - Same behavior as REPLY. The original timeline item's recipients will be added to the reply item. 188 # - DELETE - Delete the timeline item. 189 # - SHARE - Share the timeline item with the available contacts. 190 # - READ_ALOUD - Read the timeline item's speakableText aloud; if this field is not set, read the text field; if none of those fields are set, this menu item is ignored. 191 # - GET_MEDIA_INPUT - Allow users to provide media payloads to Glassware from a menu item (currently, only transcribed text from voice input is supported). Subscribe to notifications when users invoke this menu item to receive the timeline item ID. Retrieve the media from the timeline item in the payload property. 192 # - VOICE_CALL - Initiate a phone call using the timeline item's creator.phoneNumber attribute as recipient. 193 # - NAVIGATE - Navigate to the timeline item's location. 194 # - TOGGLE_PINNED - Toggle the isPinned state of the timeline item. 195 # - OPEN_URI - Open the payload of the menu item in the browser. 196 # - PLAY_VIDEO - Open the payload of the menu item in the Glass video player. 197 # - SEND_MESSAGE - Initiate sending a message to the timeline item's creator: 198 # - If the creator.phoneNumber is set and Glass is connected to an Android phone, the message is an SMS. 199 # - Otherwise, if the creator.email is set, the message is an email. 200 "id": "A String", # The ID for this menu item. This is generated by the application and is treated as an opaque token. 201 }, 202 ], 203 "isBundleCover": True or False, # Whether this item is a bundle cover. 204 # 205 # If an item is marked as a bundle cover, it will be the entry point to the bundle of items that have the same bundleId as that item. It will be shown only on the main timeline — not within the opened bundle. 206 # 207 # On the main timeline, items that are shown are: 208 # - Items that have isBundleCover set to true 209 # - Items that do not have a bundleId In a bundle sub-timeline, items that are shown are: 210 # - Items that have the bundleId in question AND isBundleCover set to false 211 "etag": "A String", # ETag for this item. 212 "id": "A String", # The ID of the timeline item. This is unique within a user's timeline. 213 "isDeleted": True or False, # When true, indicates this item is deleted, and only the ID property is set. 214 "bundleId": "A String", # The bundle ID for this item. Services can specify a bundleId to group many items together. They appear under a single top-level item on the device. 215 "isPinned": True or False, # When true, indicates this item is pinned, which means it's grouped alongside "active" items like navigation and hangouts, on the opposite side of the home screen from historical (non-pinned) timeline items. You can allow the user to toggle the value of this property with the TOGGLE_PINNED built-in menu item. 216 "title": "A String", # The title of this item. 217 "notification": { # Controls how notifications for a timeline item are presented to the user. # Controls how notifications for this item are presented on the device. If this is missing, no notification will be generated. 218 "level": "A String", # Describes how important the notification is. Allowed values are: 219 # - DEFAULT - Notifications of default importance. A chime will be played to alert users. 220 "deliveryTime": "A String", # The time at which the notification should be delivered. 221 }, 222 "speakableText": "A String", # The speakable version of the content of this item. Along with the READ_ALOUD menu item, use this field to provide text that would be clearer when read aloud, or to provide extended information to what is displayed visually on Glass. 223 # 224 # Glassware should also specify the speakableType field, which will be spoken before this text in cases where the additional context is useful, for example when the user requests that the item be read aloud following a notification. 225 "html": "A String", # HTML content for this item. If both text and html are provided for an item, the html will be rendered in the timeline. 226 # Allowed HTML elements - You can use these elements in your timeline cards. 227 # 228 # - Headers: h1, h2, h3, h4, h5, h6 229 # - Images: img 230 # - Lists: li, ol, ul 231 # - HTML5 semantics: article, aside, details, figure, figcaption, footer, header, nav, section, summary, time 232 # - Structural: blockquote, br, div, hr, p, span 233 # - Style: b, big, center, em, i, u, s, small, strike, strong, style, sub, sup 234 # - Tables: table, tbody, td, tfoot, th, thead, tr 235 # Blocked HTML elements: These elements and their contents are removed from HTML payloads. 236 # 237 # - Document headers: head, title 238 # - Embeds: audio, embed, object, source, video 239 # - Frames: frame, frameset 240 # - Scripting: applet, script 241 # Other elements: Any elements that aren't listed are removed, but their contents are preserved. 242 "location": { # A geographic location that can be associated with a timeline item. # The geographic location associated with this item. 243 "kind": "mirror#location", # The type of resource. This is always mirror#location. 244 "displayName": "A String", # The name to be displayed. This may be a business name or a user-defined place, such as "Home". 245 "timestamp": "A String", # The time at which this location was captured, formatted according to RFC 3339. 246 "longitude": 3.14, # The longitude, in degrees. 247 "address": "A String", # The full address of the location. 248 "latitude": 3.14, # The latitude, in degrees. 249 "id": "A String", # The ID of the location. 250 "accuracy": 3.14, # The accuracy of the location fix in meters. 251 }, 252 "sourceItemId": "A String", # Opaque string you can use to map a timeline item to data in your own service. 253 "inReplyTo": "A String", # If this item was generated as a reply to another item, this field will be set to the ID of the item being replied to. This can be used to attach a reply to the appropriate conversation or post. 254 "updated": "A String", # The time at which this item was last modified, formatted according to RFC 3339. 255 "canonicalUrl": "A String", # A canonical URL pointing to the canonical/high quality version of the data represented by the timeline item. 256 "recipients": [ # A list of users or groups that this item has been shared with. 257 { # A person or group that can be used as a creator or a contact. 258 "kind": "mirror#contact", # The type of resource. This is always mirror#contact. 259 "displayName": "A String", # The name to display for this contact. 260 "acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items. 261 "A String", 262 ], 263 "imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client. 264 "A String", 265 ], 266 "priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities. 267 "source": "A String", # The ID of the application that created this contact. This is populated by the API 268 "phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number. 269 "sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are: 270 # - ADD_CAPTION 271 "A String", 272 ], 273 "type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are: 274 # - INDIVIDUAL - Represents a single person. This is the default. 275 # - GROUP - Represents more than a single person. 276 "acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command. 277 { # A single menu command that is part of a Contact. 278 "type": "A String", # The type of operation this command corresponds to. Allowed values are: 279 # - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command. 280 # - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command. 281 }, 282 ], 283 "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token. 284 "speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic. 285 }, 286 ], 287 "kind": "mirror#timelineItem", # The type of resource. This is always mirror#timelineItem. 288 "created": "A String", # The time at which this item was created, formatted according to RFC 3339. 289 "pinScore": 42, # For pinned items, this determines the order in which the item is displayed in the timeline, with a higher score appearing closer to the clock. Note: setting this field is currently not supported. 290 "speakableType": "A String", # A speakable description of the type of this item. This will be announced to the user prior to reading the content of the item in cases where the additional context is useful, for example when the user requests that the item be read aloud following a notification. 291 # 292 # This should be a short, simple noun phrase such as "Email", "Text message", or "Daily Planet News Update". 293 # 294 # Glassware are encouraged to populate this field for every timeline item, even if the item does not contain speakableText or text so that the user can learn the type of the item without looking at the screen. 295 "selfLink": "A String", # A URL that can be used to retrieve this item. 296 }</pre> 297</div> 298 299<div class="method"> 300 <code class="details" id="insert">insert(body=None, media_body=None, media_mime_type=None)</code> 301 <pre>Inserts a new item into the timeline. 302 303Args: 304 body: object, The request body. 305 The object takes the form of: 306 307{ # Each item in the user's timeline is represented as a TimelineItem JSON structure, described below. 308 "attachments": [ # A list of media attachments associated with this item. As a convenience, you can refer to attachments in your HTML payloads with the attachment or cid scheme. For example: 309 # - attachment: <img src="attachment:attachment_index"> where attachment_index is the 0-based index of this array. 310 # - cid: <img src="cid:attachment_id"> where attachment_id is the ID of the attachment. 311 { # Represents media content, such as a photo, that can be attached to a timeline item. 312 "contentUrl": "A String", # The URL for the content. 313 "contentType": "A String", # The MIME type of the attachment. 314 "id": "A String", # The ID of the attachment. 315 "isProcessingContent": True or False, # Indicates that the contentUrl is not available because the attachment content is still being processed. If the caller wishes to retrieve the content, it should try again later. 316 }, 317 ], 318 "displayTime": "A String", # The time that should be displayed when this item is viewed in the timeline, formatted according to RFC 3339. This user's timeline is sorted chronologically on display time, so this will also determine where the item is displayed in the timeline. If not set by the service, the display time defaults to the updated time. 319 "creator": { # A person or group that can be used as a creator or a contact. # The user or group that created this item. 320 "kind": "mirror#contact", # The type of resource. This is always mirror#contact. 321 "displayName": "A String", # The name to display for this contact. 322 "acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items. 323 "A String", 324 ], 325 "imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client. 326 "A String", 327 ], 328 "priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities. 329 "source": "A String", # The ID of the application that created this contact. This is populated by the API 330 "phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number. 331 "sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are: 332 # - ADD_CAPTION 333 "A String", 334 ], 335 "type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are: 336 # - INDIVIDUAL - Represents a single person. This is the default. 337 # - GROUP - Represents more than a single person. 338 "acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command. 339 { # A single menu command that is part of a Contact. 340 "type": "A String", # The type of operation this command corresponds to. Allowed values are: 341 # - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command. 342 # - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command. 343 }, 344 ], 345 "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token. 346 "speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic. 347 }, 348 "text": "A String", # Text content of this item. 349 "menuItems": [ # A list of menu items that will be presented to the user when this item is selected in the timeline. 350 { # A custom menu item that can be presented to the user by a timeline item. 351 "contextual_command": "A String", # The ContextualMenus.Command associated with this MenuItem (e.g. READ_ALOUD). The voice label for this command will be displayed in the voice menu and the touch label will be displayed in the touch menu. Note that the default menu value's display name will be overriden if you specify this property. Values that do not correspond to a ContextualMenus.Command name will be ignored. 352 "removeWhenSelected": True or False, # If set to true on a CUSTOM menu item, that item will be removed from the menu after it is selected. 353 "payload": "A String", # A generic payload whose meaning changes depending on this MenuItem's action. 354 # - When the action is OPEN_URI, the payload is the URL of the website to view. 355 # - When the action is PLAY_VIDEO, the payload is the streaming URL of the video 356 # - When the action is GET_MEDIA_INPUT, the payload is the text transcription of a user's speech input 357 "values": [ # For CUSTOM items, a list of values controlling the appearance of the menu item in each of its states. A value for the DEFAULT state must be provided. If the PENDING or CONFIRMED states are missing, they will not be shown. 358 { # A single value that is part of a MenuItem. 359 "iconUrl": "A String", # URL of an icon to display with the menu item. 360 "state": "A String", # The state that this value applies to. Allowed values are: 361 # - DEFAULT - Default value shown when displayed in the menuItems list. 362 # - PENDING - Value shown when the menuItem has been selected by the user but can still be cancelled. 363 # - CONFIRMED - Value shown when the menuItem has been selected by the user and can no longer be cancelled. 364 "displayName": "A String", # The name to display for the menu item. If you specify this property for a built-in menu item, the default contextual voice command for that menu item is not shown. 365 }, 366 ], 367 "action": "A String", # Controls the behavior when the user picks the menu option. Allowed values are: 368 # - CUSTOM - Custom action set by the service. When the user selects this menuItem, the API triggers a notification to your callbackUrl with the userActions.type set to CUSTOM and the userActions.payload set to the ID of this menu item. This is the default value. 369 # - Built-in actions: 370 # - REPLY - Initiate a reply to the timeline item using the voice recording UI. The creator attribute must be set in the timeline item for this menu to be available. 371 # - REPLY_ALL - Same behavior as REPLY. The original timeline item's recipients will be added to the reply item. 372 # - DELETE - Delete the timeline item. 373 # - SHARE - Share the timeline item with the available contacts. 374 # - READ_ALOUD - Read the timeline item's speakableText aloud; if this field is not set, read the text field; if none of those fields are set, this menu item is ignored. 375 # - GET_MEDIA_INPUT - Allow users to provide media payloads to Glassware from a menu item (currently, only transcribed text from voice input is supported). Subscribe to notifications when users invoke this menu item to receive the timeline item ID. Retrieve the media from the timeline item in the payload property. 376 # - VOICE_CALL - Initiate a phone call using the timeline item's creator.phoneNumber attribute as recipient. 377 # - NAVIGATE - Navigate to the timeline item's location. 378 # - TOGGLE_PINNED - Toggle the isPinned state of the timeline item. 379 # - OPEN_URI - Open the payload of the menu item in the browser. 380 # - PLAY_VIDEO - Open the payload of the menu item in the Glass video player. 381 # - SEND_MESSAGE - Initiate sending a message to the timeline item's creator: 382 # - If the creator.phoneNumber is set and Glass is connected to an Android phone, the message is an SMS. 383 # - Otherwise, if the creator.email is set, the message is an email. 384 "id": "A String", # The ID for this menu item. This is generated by the application and is treated as an opaque token. 385 }, 386 ], 387 "isBundleCover": True or False, # Whether this item is a bundle cover. 388 # 389 # If an item is marked as a bundle cover, it will be the entry point to the bundle of items that have the same bundleId as that item. It will be shown only on the main timeline — not within the opened bundle. 390 # 391 # On the main timeline, items that are shown are: 392 # - Items that have isBundleCover set to true 393 # - Items that do not have a bundleId In a bundle sub-timeline, items that are shown are: 394 # - Items that have the bundleId in question AND isBundleCover set to false 395 "etag": "A String", # ETag for this item. 396 "id": "A String", # The ID of the timeline item. This is unique within a user's timeline. 397 "isDeleted": True or False, # When true, indicates this item is deleted, and only the ID property is set. 398 "bundleId": "A String", # The bundle ID for this item. Services can specify a bundleId to group many items together. They appear under a single top-level item on the device. 399 "isPinned": True or False, # When true, indicates this item is pinned, which means it's grouped alongside "active" items like navigation and hangouts, on the opposite side of the home screen from historical (non-pinned) timeline items. You can allow the user to toggle the value of this property with the TOGGLE_PINNED built-in menu item. 400 "title": "A String", # The title of this item. 401 "notification": { # Controls how notifications for a timeline item are presented to the user. # Controls how notifications for this item are presented on the device. If this is missing, no notification will be generated. 402 "level": "A String", # Describes how important the notification is. Allowed values are: 403 # - DEFAULT - Notifications of default importance. A chime will be played to alert users. 404 "deliveryTime": "A String", # The time at which the notification should be delivered. 405 }, 406 "speakableText": "A String", # The speakable version of the content of this item. Along with the READ_ALOUD menu item, use this field to provide text that would be clearer when read aloud, or to provide extended information to what is displayed visually on Glass. 407 # 408 # Glassware should also specify the speakableType field, which will be spoken before this text in cases where the additional context is useful, for example when the user requests that the item be read aloud following a notification. 409 "html": "A String", # HTML content for this item. If both text and html are provided for an item, the html will be rendered in the timeline. 410 # Allowed HTML elements - You can use these elements in your timeline cards. 411 # 412 # - Headers: h1, h2, h3, h4, h5, h6 413 # - Images: img 414 # - Lists: li, ol, ul 415 # - HTML5 semantics: article, aside, details, figure, figcaption, footer, header, nav, section, summary, time 416 # - Structural: blockquote, br, div, hr, p, span 417 # - Style: b, big, center, em, i, u, s, small, strike, strong, style, sub, sup 418 # - Tables: table, tbody, td, tfoot, th, thead, tr 419 # Blocked HTML elements: These elements and their contents are removed from HTML payloads. 420 # 421 # - Document headers: head, title 422 # - Embeds: audio, embed, object, source, video 423 # - Frames: frame, frameset 424 # - Scripting: applet, script 425 # Other elements: Any elements that aren't listed are removed, but their contents are preserved. 426 "location": { # A geographic location that can be associated with a timeline item. # The geographic location associated with this item. 427 "kind": "mirror#location", # The type of resource. This is always mirror#location. 428 "displayName": "A String", # The name to be displayed. This may be a business name or a user-defined place, such as "Home". 429 "timestamp": "A String", # The time at which this location was captured, formatted according to RFC 3339. 430 "longitude": 3.14, # The longitude, in degrees. 431 "address": "A String", # The full address of the location. 432 "latitude": 3.14, # The latitude, in degrees. 433 "id": "A String", # The ID of the location. 434 "accuracy": 3.14, # The accuracy of the location fix in meters. 435 }, 436 "sourceItemId": "A String", # Opaque string you can use to map a timeline item to data in your own service. 437 "inReplyTo": "A String", # If this item was generated as a reply to another item, this field will be set to the ID of the item being replied to. This can be used to attach a reply to the appropriate conversation or post. 438 "updated": "A String", # The time at which this item was last modified, formatted according to RFC 3339. 439 "canonicalUrl": "A String", # A canonical URL pointing to the canonical/high quality version of the data represented by the timeline item. 440 "recipients": [ # A list of users or groups that this item has been shared with. 441 { # A person or group that can be used as a creator or a contact. 442 "kind": "mirror#contact", # The type of resource. This is always mirror#contact. 443 "displayName": "A String", # The name to display for this contact. 444 "acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items. 445 "A String", 446 ], 447 "imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client. 448 "A String", 449 ], 450 "priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities. 451 "source": "A String", # The ID of the application that created this contact. This is populated by the API 452 "phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number. 453 "sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are: 454 # - ADD_CAPTION 455 "A String", 456 ], 457 "type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are: 458 # - INDIVIDUAL - Represents a single person. This is the default. 459 # - GROUP - Represents more than a single person. 460 "acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command. 461 { # A single menu command that is part of a Contact. 462 "type": "A String", # The type of operation this command corresponds to. Allowed values are: 463 # - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command. 464 # - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command. 465 }, 466 ], 467 "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token. 468 "speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic. 469 }, 470 ], 471 "kind": "mirror#timelineItem", # The type of resource. This is always mirror#timelineItem. 472 "created": "A String", # The time at which this item was created, formatted according to RFC 3339. 473 "pinScore": 42, # For pinned items, this determines the order in which the item is displayed in the timeline, with a higher score appearing closer to the clock. Note: setting this field is currently not supported. 474 "speakableType": "A String", # A speakable description of the type of this item. This will be announced to the user prior to reading the content of the item in cases where the additional context is useful, for example when the user requests that the item be read aloud following a notification. 475 # 476 # This should be a short, simple noun phrase such as "Email", "Text message", or "Daily Planet News Update". 477 # 478 # Glassware are encouraged to populate this field for every timeline item, even if the item does not contain speakableText or text so that the user can learn the type of the item without looking at the screen. 479 "selfLink": "A String", # A URL that can be used to retrieve this item. 480 } 481 482 media_body: string, The filename of the media request body, or an instance of a MediaUpload object. 483 media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object. 484 485Returns: 486 An object of the form: 487 488 { # Each item in the user's timeline is represented as a TimelineItem JSON structure, described below. 489 "attachments": [ # A list of media attachments associated with this item. As a convenience, you can refer to attachments in your HTML payloads with the attachment or cid scheme. For example: 490 # - attachment: <img src="attachment:attachment_index"> where attachment_index is the 0-based index of this array. 491 # - cid: <img src="cid:attachment_id"> where attachment_id is the ID of the attachment. 492 { # Represents media content, such as a photo, that can be attached to a timeline item. 493 "contentUrl": "A String", # The URL for the content. 494 "contentType": "A String", # The MIME type of the attachment. 495 "id": "A String", # The ID of the attachment. 496 "isProcessingContent": True or False, # Indicates that the contentUrl is not available because the attachment content is still being processed. If the caller wishes to retrieve the content, it should try again later. 497 }, 498 ], 499 "displayTime": "A String", # The time that should be displayed when this item is viewed in the timeline, formatted according to RFC 3339. This user's timeline is sorted chronologically on display time, so this will also determine where the item is displayed in the timeline. If not set by the service, the display time defaults to the updated time. 500 "creator": { # A person or group that can be used as a creator or a contact. # The user or group that created this item. 501 "kind": "mirror#contact", # The type of resource. This is always mirror#contact. 502 "displayName": "A String", # The name to display for this contact. 503 "acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items. 504 "A String", 505 ], 506 "imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client. 507 "A String", 508 ], 509 "priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities. 510 "source": "A String", # The ID of the application that created this contact. This is populated by the API 511 "phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number. 512 "sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are: 513 # - ADD_CAPTION 514 "A String", 515 ], 516 "type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are: 517 # - INDIVIDUAL - Represents a single person. This is the default. 518 # - GROUP - Represents more than a single person. 519 "acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command. 520 { # A single menu command that is part of a Contact. 521 "type": "A String", # The type of operation this command corresponds to. Allowed values are: 522 # - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command. 523 # - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command. 524 }, 525 ], 526 "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token. 527 "speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic. 528 }, 529 "text": "A String", # Text content of this item. 530 "menuItems": [ # A list of menu items that will be presented to the user when this item is selected in the timeline. 531 { # A custom menu item that can be presented to the user by a timeline item. 532 "contextual_command": "A String", # The ContextualMenus.Command associated with this MenuItem (e.g. READ_ALOUD). The voice label for this command will be displayed in the voice menu and the touch label will be displayed in the touch menu. Note that the default menu value's display name will be overriden if you specify this property. Values that do not correspond to a ContextualMenus.Command name will be ignored. 533 "removeWhenSelected": True or False, # If set to true on a CUSTOM menu item, that item will be removed from the menu after it is selected. 534 "payload": "A String", # A generic payload whose meaning changes depending on this MenuItem's action. 535 # - When the action is OPEN_URI, the payload is the URL of the website to view. 536 # - When the action is PLAY_VIDEO, the payload is the streaming URL of the video 537 # - When the action is GET_MEDIA_INPUT, the payload is the text transcription of a user's speech input 538 "values": [ # For CUSTOM items, a list of values controlling the appearance of the menu item in each of its states. A value for the DEFAULT state must be provided. If the PENDING or CONFIRMED states are missing, they will not be shown. 539 { # A single value that is part of a MenuItem. 540 "iconUrl": "A String", # URL of an icon to display with the menu item. 541 "state": "A String", # The state that this value applies to. Allowed values are: 542 # - DEFAULT - Default value shown when displayed in the menuItems list. 543 # - PENDING - Value shown when the menuItem has been selected by the user but can still be cancelled. 544 # - CONFIRMED - Value shown when the menuItem has been selected by the user and can no longer be cancelled. 545 "displayName": "A String", # The name to display for the menu item. If you specify this property for a built-in menu item, the default contextual voice command for that menu item is not shown. 546 }, 547 ], 548 "action": "A String", # Controls the behavior when the user picks the menu option. Allowed values are: 549 # - CUSTOM - Custom action set by the service. When the user selects this menuItem, the API triggers a notification to your callbackUrl with the userActions.type set to CUSTOM and the userActions.payload set to the ID of this menu item. This is the default value. 550 # - Built-in actions: 551 # - REPLY - Initiate a reply to the timeline item using the voice recording UI. The creator attribute must be set in the timeline item for this menu to be available. 552 # - REPLY_ALL - Same behavior as REPLY. The original timeline item's recipients will be added to the reply item. 553 # - DELETE - Delete the timeline item. 554 # - SHARE - Share the timeline item with the available contacts. 555 # - READ_ALOUD - Read the timeline item's speakableText aloud; if this field is not set, read the text field; if none of those fields are set, this menu item is ignored. 556 # - GET_MEDIA_INPUT - Allow users to provide media payloads to Glassware from a menu item (currently, only transcribed text from voice input is supported). Subscribe to notifications when users invoke this menu item to receive the timeline item ID. Retrieve the media from the timeline item in the payload property. 557 # - VOICE_CALL - Initiate a phone call using the timeline item's creator.phoneNumber attribute as recipient. 558 # - NAVIGATE - Navigate to the timeline item's location. 559 # - TOGGLE_PINNED - Toggle the isPinned state of the timeline item. 560 # - OPEN_URI - Open the payload of the menu item in the browser. 561 # - PLAY_VIDEO - Open the payload of the menu item in the Glass video player. 562 # - SEND_MESSAGE - Initiate sending a message to the timeline item's creator: 563 # - If the creator.phoneNumber is set and Glass is connected to an Android phone, the message is an SMS. 564 # - Otherwise, if the creator.email is set, the message is an email. 565 "id": "A String", # The ID for this menu item. This is generated by the application and is treated as an opaque token. 566 }, 567 ], 568 "isBundleCover": True or False, # Whether this item is a bundle cover. 569 # 570 # If an item is marked as a bundle cover, it will be the entry point to the bundle of items that have the same bundleId as that item. It will be shown only on the main timeline — not within the opened bundle. 571 # 572 # On the main timeline, items that are shown are: 573 # - Items that have isBundleCover set to true 574 # - Items that do not have a bundleId In a bundle sub-timeline, items that are shown are: 575 # - Items that have the bundleId in question AND isBundleCover set to false 576 "etag": "A String", # ETag for this item. 577 "id": "A String", # The ID of the timeline item. This is unique within a user's timeline. 578 "isDeleted": True or False, # When true, indicates this item is deleted, and only the ID property is set. 579 "bundleId": "A String", # The bundle ID for this item. Services can specify a bundleId to group many items together. They appear under a single top-level item on the device. 580 "isPinned": True or False, # When true, indicates this item is pinned, which means it's grouped alongside "active" items like navigation and hangouts, on the opposite side of the home screen from historical (non-pinned) timeline items. You can allow the user to toggle the value of this property with the TOGGLE_PINNED built-in menu item. 581 "title": "A String", # The title of this item. 582 "notification": { # Controls how notifications for a timeline item are presented to the user. # Controls how notifications for this item are presented on the device. If this is missing, no notification will be generated. 583 "level": "A String", # Describes how important the notification is. Allowed values are: 584 # - DEFAULT - Notifications of default importance. A chime will be played to alert users. 585 "deliveryTime": "A String", # The time at which the notification should be delivered. 586 }, 587 "speakableText": "A String", # The speakable version of the content of this item. Along with the READ_ALOUD menu item, use this field to provide text that would be clearer when read aloud, or to provide extended information to what is displayed visually on Glass. 588 # 589 # Glassware should also specify the speakableType field, which will be spoken before this text in cases where the additional context is useful, for example when the user requests that the item be read aloud following a notification. 590 "html": "A String", # HTML content for this item. If both text and html are provided for an item, the html will be rendered in the timeline. 591 # Allowed HTML elements - You can use these elements in your timeline cards. 592 # 593 # - Headers: h1, h2, h3, h4, h5, h6 594 # - Images: img 595 # - Lists: li, ol, ul 596 # - HTML5 semantics: article, aside, details, figure, figcaption, footer, header, nav, section, summary, time 597 # - Structural: blockquote, br, div, hr, p, span 598 # - Style: b, big, center, em, i, u, s, small, strike, strong, style, sub, sup 599 # - Tables: table, tbody, td, tfoot, th, thead, tr 600 # Blocked HTML elements: These elements and their contents are removed from HTML payloads. 601 # 602 # - Document headers: head, title 603 # - Embeds: audio, embed, object, source, video 604 # - Frames: frame, frameset 605 # - Scripting: applet, script 606 # Other elements: Any elements that aren't listed are removed, but their contents are preserved. 607 "location": { # A geographic location that can be associated with a timeline item. # The geographic location associated with this item. 608 "kind": "mirror#location", # The type of resource. This is always mirror#location. 609 "displayName": "A String", # The name to be displayed. This may be a business name or a user-defined place, such as "Home". 610 "timestamp": "A String", # The time at which this location was captured, formatted according to RFC 3339. 611 "longitude": 3.14, # The longitude, in degrees. 612 "address": "A String", # The full address of the location. 613 "latitude": 3.14, # The latitude, in degrees. 614 "id": "A String", # The ID of the location. 615 "accuracy": 3.14, # The accuracy of the location fix in meters. 616 }, 617 "sourceItemId": "A String", # Opaque string you can use to map a timeline item to data in your own service. 618 "inReplyTo": "A String", # If this item was generated as a reply to another item, this field will be set to the ID of the item being replied to. This can be used to attach a reply to the appropriate conversation or post. 619 "updated": "A String", # The time at which this item was last modified, formatted according to RFC 3339. 620 "canonicalUrl": "A String", # A canonical URL pointing to the canonical/high quality version of the data represented by the timeline item. 621 "recipients": [ # A list of users or groups that this item has been shared with. 622 { # A person or group that can be used as a creator or a contact. 623 "kind": "mirror#contact", # The type of resource. This is always mirror#contact. 624 "displayName": "A String", # The name to display for this contact. 625 "acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items. 626 "A String", 627 ], 628 "imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client. 629 "A String", 630 ], 631 "priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities. 632 "source": "A String", # The ID of the application that created this contact. This is populated by the API 633 "phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number. 634 "sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are: 635 # - ADD_CAPTION 636 "A String", 637 ], 638 "type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are: 639 # - INDIVIDUAL - Represents a single person. This is the default. 640 # - GROUP - Represents more than a single person. 641 "acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command. 642 { # A single menu command that is part of a Contact. 643 "type": "A String", # The type of operation this command corresponds to. Allowed values are: 644 # - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command. 645 # - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command. 646 }, 647 ], 648 "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token. 649 "speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic. 650 }, 651 ], 652 "kind": "mirror#timelineItem", # The type of resource. This is always mirror#timelineItem. 653 "created": "A String", # The time at which this item was created, formatted according to RFC 3339. 654 "pinScore": 42, # For pinned items, this determines the order in which the item is displayed in the timeline, with a higher score appearing closer to the clock. Note: setting this field is currently not supported. 655 "speakableType": "A String", # A speakable description of the type of this item. This will be announced to the user prior to reading the content of the item in cases where the additional context is useful, for example when the user requests that the item be read aloud following a notification. 656 # 657 # This should be a short, simple noun phrase such as "Email", "Text message", or "Daily Planet News Update". 658 # 659 # Glassware are encouraged to populate this field for every timeline item, even if the item does not contain speakableText or text so that the user can learn the type of the item without looking at the screen. 660 "selfLink": "A String", # A URL that can be used to retrieve this item. 661 }</pre> 662</div> 663 664<div class="method"> 665 <code class="details" id="list">list(orderBy=None, includeDeleted=None, pageToken=None, maxResults=None, pinnedOnly=None, sourceItemId=None, bundleId=None)</code> 666 <pre>Retrieves a list of timeline items for the authenticated user. 667 668Args: 669 orderBy: string, Controls the order in which timeline items are returned. 670 Allowed values 671 displayTime - Results will be ordered by displayTime (default). This is the same ordering as is used in the timeline on the device. 672 writeTime - Results will be ordered by the time at which they were last written to the data store. 673 includeDeleted: boolean, If true, tombstone records for deleted items will be returned. 674 pageToken: string, Token for the page of results to return. 675 maxResults: integer, The maximum number of items to include in the response, used for paging. 676 pinnedOnly: boolean, If true, only pinned items will be returned. 677 sourceItemId: string, If provided, only items with the given sourceItemId will be returned. 678 bundleId: string, If provided, only items with the given bundleId will be returned. 679 680Returns: 681 An object of the form: 682 683 { # A list of timeline items. This is the response from the server to GET requests on the timeline collection. 684 "nextPageToken": "A String", # The next page token. Provide this as the pageToken parameter in the request to retrieve the next page of results. 685 "items": [ # Items in the timeline. 686 { # Each item in the user's timeline is represented as a TimelineItem JSON structure, described below. 687 "attachments": [ # A list of media attachments associated with this item. As a convenience, you can refer to attachments in your HTML payloads with the attachment or cid scheme. For example: 688 # - attachment: <img src="attachment:attachment_index"> where attachment_index is the 0-based index of this array. 689 # - cid: <img src="cid:attachment_id"> where attachment_id is the ID of the attachment. 690 { # Represents media content, such as a photo, that can be attached to a timeline item. 691 "contentUrl": "A String", # The URL for the content. 692 "contentType": "A String", # The MIME type of the attachment. 693 "id": "A String", # The ID of the attachment. 694 "isProcessingContent": True or False, # Indicates that the contentUrl is not available because the attachment content is still being processed. If the caller wishes to retrieve the content, it should try again later. 695 }, 696 ], 697 "displayTime": "A String", # The time that should be displayed when this item is viewed in the timeline, formatted according to RFC 3339. This user's timeline is sorted chronologically on display time, so this will also determine where the item is displayed in the timeline. If not set by the service, the display time defaults to the updated time. 698 "creator": { # A person or group that can be used as a creator or a contact. # The user or group that created this item. 699 "kind": "mirror#contact", # The type of resource. This is always mirror#contact. 700 "displayName": "A String", # The name to display for this contact. 701 "acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items. 702 "A String", 703 ], 704 "imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client. 705 "A String", 706 ], 707 "priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities. 708 "source": "A String", # The ID of the application that created this contact. This is populated by the API 709 "phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number. 710 "sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are: 711 # - ADD_CAPTION 712 "A String", 713 ], 714 "type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are: 715 # - INDIVIDUAL - Represents a single person. This is the default. 716 # - GROUP - Represents more than a single person. 717 "acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command. 718 { # A single menu command that is part of a Contact. 719 "type": "A String", # The type of operation this command corresponds to. Allowed values are: 720 # - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command. 721 # - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command. 722 }, 723 ], 724 "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token. 725 "speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic. 726 }, 727 "text": "A String", # Text content of this item. 728 "menuItems": [ # A list of menu items that will be presented to the user when this item is selected in the timeline. 729 { # A custom menu item that can be presented to the user by a timeline item. 730 "contextual_command": "A String", # The ContextualMenus.Command associated with this MenuItem (e.g. READ_ALOUD). The voice label for this command will be displayed in the voice menu and the touch label will be displayed in the touch menu. Note that the default menu value's display name will be overriden if you specify this property. Values that do not correspond to a ContextualMenus.Command name will be ignored. 731 "removeWhenSelected": True or False, # If set to true on a CUSTOM menu item, that item will be removed from the menu after it is selected. 732 "payload": "A String", # A generic payload whose meaning changes depending on this MenuItem's action. 733 # - When the action is OPEN_URI, the payload is the URL of the website to view. 734 # - When the action is PLAY_VIDEO, the payload is the streaming URL of the video 735 # - When the action is GET_MEDIA_INPUT, the payload is the text transcription of a user's speech input 736 "values": [ # For CUSTOM items, a list of values controlling the appearance of the menu item in each of its states. A value for the DEFAULT state must be provided. If the PENDING or CONFIRMED states are missing, they will not be shown. 737 { # A single value that is part of a MenuItem. 738 "iconUrl": "A String", # URL of an icon to display with the menu item. 739 "state": "A String", # The state that this value applies to. Allowed values are: 740 # - DEFAULT - Default value shown when displayed in the menuItems list. 741 # - PENDING - Value shown when the menuItem has been selected by the user but can still be cancelled. 742 # - CONFIRMED - Value shown when the menuItem has been selected by the user and can no longer be cancelled. 743 "displayName": "A String", # The name to display for the menu item. If you specify this property for a built-in menu item, the default contextual voice command for that menu item is not shown. 744 }, 745 ], 746 "action": "A String", # Controls the behavior when the user picks the menu option. Allowed values are: 747 # - CUSTOM - Custom action set by the service. When the user selects this menuItem, the API triggers a notification to your callbackUrl with the userActions.type set to CUSTOM and the userActions.payload set to the ID of this menu item. This is the default value. 748 # - Built-in actions: 749 # - REPLY - Initiate a reply to the timeline item using the voice recording UI. The creator attribute must be set in the timeline item for this menu to be available. 750 # - REPLY_ALL - Same behavior as REPLY. The original timeline item's recipients will be added to the reply item. 751 # - DELETE - Delete the timeline item. 752 # - SHARE - Share the timeline item with the available contacts. 753 # - READ_ALOUD - Read the timeline item's speakableText aloud; if this field is not set, read the text field; if none of those fields are set, this menu item is ignored. 754 # - GET_MEDIA_INPUT - Allow users to provide media payloads to Glassware from a menu item (currently, only transcribed text from voice input is supported). Subscribe to notifications when users invoke this menu item to receive the timeline item ID. Retrieve the media from the timeline item in the payload property. 755 # - VOICE_CALL - Initiate a phone call using the timeline item's creator.phoneNumber attribute as recipient. 756 # - NAVIGATE - Navigate to the timeline item's location. 757 # - TOGGLE_PINNED - Toggle the isPinned state of the timeline item. 758 # - OPEN_URI - Open the payload of the menu item in the browser. 759 # - PLAY_VIDEO - Open the payload of the menu item in the Glass video player. 760 # - SEND_MESSAGE - Initiate sending a message to the timeline item's creator: 761 # - If the creator.phoneNumber is set and Glass is connected to an Android phone, the message is an SMS. 762 # - Otherwise, if the creator.email is set, the message is an email. 763 "id": "A String", # The ID for this menu item. This is generated by the application and is treated as an opaque token. 764 }, 765 ], 766 "isBundleCover": True or False, # Whether this item is a bundle cover. 767 # 768 # If an item is marked as a bundle cover, it will be the entry point to the bundle of items that have the same bundleId as that item. It will be shown only on the main timeline — not within the opened bundle. 769 # 770 # On the main timeline, items that are shown are: 771 # - Items that have isBundleCover set to true 772 # - Items that do not have a bundleId In a bundle sub-timeline, items that are shown are: 773 # - Items that have the bundleId in question AND isBundleCover set to false 774 "etag": "A String", # ETag for this item. 775 "id": "A String", # The ID of the timeline item. This is unique within a user's timeline. 776 "isDeleted": True or False, # When true, indicates this item is deleted, and only the ID property is set. 777 "bundleId": "A String", # The bundle ID for this item. Services can specify a bundleId to group many items together. They appear under a single top-level item on the device. 778 "isPinned": True or False, # When true, indicates this item is pinned, which means it's grouped alongside "active" items like navigation and hangouts, on the opposite side of the home screen from historical (non-pinned) timeline items. You can allow the user to toggle the value of this property with the TOGGLE_PINNED built-in menu item. 779 "title": "A String", # The title of this item. 780 "notification": { # Controls how notifications for a timeline item are presented to the user. # Controls how notifications for this item are presented on the device. If this is missing, no notification will be generated. 781 "level": "A String", # Describes how important the notification is. Allowed values are: 782 # - DEFAULT - Notifications of default importance. A chime will be played to alert users. 783 "deliveryTime": "A String", # The time at which the notification should be delivered. 784 }, 785 "speakableText": "A String", # The speakable version of the content of this item. Along with the READ_ALOUD menu item, use this field to provide text that would be clearer when read aloud, or to provide extended information to what is displayed visually on Glass. 786 # 787 # Glassware should also specify the speakableType field, which will be spoken before this text in cases where the additional context is useful, for example when the user requests that the item be read aloud following a notification. 788 "html": "A String", # HTML content for this item. If both text and html are provided for an item, the html will be rendered in the timeline. 789 # Allowed HTML elements - You can use these elements in your timeline cards. 790 # 791 # - Headers: h1, h2, h3, h4, h5, h6 792 # - Images: img 793 # - Lists: li, ol, ul 794 # - HTML5 semantics: article, aside, details, figure, figcaption, footer, header, nav, section, summary, time 795 # - Structural: blockquote, br, div, hr, p, span 796 # - Style: b, big, center, em, i, u, s, small, strike, strong, style, sub, sup 797 # - Tables: table, tbody, td, tfoot, th, thead, tr 798 # Blocked HTML elements: These elements and their contents are removed from HTML payloads. 799 # 800 # - Document headers: head, title 801 # - Embeds: audio, embed, object, source, video 802 # - Frames: frame, frameset 803 # - Scripting: applet, script 804 # Other elements: Any elements that aren't listed are removed, but their contents are preserved. 805 "location": { # A geographic location that can be associated with a timeline item. # The geographic location associated with this item. 806 "kind": "mirror#location", # The type of resource. This is always mirror#location. 807 "displayName": "A String", # The name to be displayed. This may be a business name or a user-defined place, such as "Home". 808 "timestamp": "A String", # The time at which this location was captured, formatted according to RFC 3339. 809 "longitude": 3.14, # The longitude, in degrees. 810 "address": "A String", # The full address of the location. 811 "latitude": 3.14, # The latitude, in degrees. 812 "id": "A String", # The ID of the location. 813 "accuracy": 3.14, # The accuracy of the location fix in meters. 814 }, 815 "sourceItemId": "A String", # Opaque string you can use to map a timeline item to data in your own service. 816 "inReplyTo": "A String", # If this item was generated as a reply to another item, this field will be set to the ID of the item being replied to. This can be used to attach a reply to the appropriate conversation or post. 817 "updated": "A String", # The time at which this item was last modified, formatted according to RFC 3339. 818 "canonicalUrl": "A String", # A canonical URL pointing to the canonical/high quality version of the data represented by the timeline item. 819 "recipients": [ # A list of users or groups that this item has been shared with. 820 { # A person or group that can be used as a creator or a contact. 821 "kind": "mirror#contact", # The type of resource. This is always mirror#contact. 822 "displayName": "A String", # The name to display for this contact. 823 "acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items. 824 "A String", 825 ], 826 "imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client. 827 "A String", 828 ], 829 "priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities. 830 "source": "A String", # The ID of the application that created this contact. This is populated by the API 831 "phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number. 832 "sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are: 833 # - ADD_CAPTION 834 "A String", 835 ], 836 "type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are: 837 # - INDIVIDUAL - Represents a single person. This is the default. 838 # - GROUP - Represents more than a single person. 839 "acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command. 840 { # A single menu command that is part of a Contact. 841 "type": "A String", # The type of operation this command corresponds to. Allowed values are: 842 # - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command. 843 # - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command. 844 }, 845 ], 846 "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token. 847 "speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic. 848 }, 849 ], 850 "kind": "mirror#timelineItem", # The type of resource. This is always mirror#timelineItem. 851 "created": "A String", # The time at which this item was created, formatted according to RFC 3339. 852 "pinScore": 42, # For pinned items, this determines the order in which the item is displayed in the timeline, with a higher score appearing closer to the clock. Note: setting this field is currently not supported. 853 "speakableType": "A String", # A speakable description of the type of this item. This will be announced to the user prior to reading the content of the item in cases where the additional context is useful, for example when the user requests that the item be read aloud following a notification. 854 # 855 # This should be a short, simple noun phrase such as "Email", "Text message", or "Daily Planet News Update". 856 # 857 # Glassware are encouraged to populate this field for every timeline item, even if the item does not contain speakableText or text so that the user can learn the type of the item without looking at the screen. 858 "selfLink": "A String", # A URL that can be used to retrieve this item. 859 }, 860 ], 861 "kind": "mirror#timeline", # The type of resource. This is always mirror#timeline. 862 }</pre> 863</div> 864 865<div class="method"> 866 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 867 <pre>Retrieves the next page of results. 868 869Args: 870 previous_request: The request for the previous page. (required) 871 previous_response: The response from the request for the previous page. (required) 872 873Returns: 874 A request object that you can call 'execute()' on to request the next 875 page. Returns None if there are no more items in the collection. 876 </pre> 877</div> 878 879<div class="method"> 880 <code class="details" id="patch">patch(id, body)</code> 881 <pre>Updates a timeline item in place. This method supports patch semantics. 882 883Args: 884 id: string, The ID of the timeline item. (required) 885 body: object, The request body. (required) 886 The object takes the form of: 887 888{ # Each item in the user's timeline is represented as a TimelineItem JSON structure, described below. 889 "attachments": [ # A list of media attachments associated with this item. As a convenience, you can refer to attachments in your HTML payloads with the attachment or cid scheme. For example: 890 # - attachment: <img src="attachment:attachment_index"> where attachment_index is the 0-based index of this array. 891 # - cid: <img src="cid:attachment_id"> where attachment_id is the ID of the attachment. 892 { # Represents media content, such as a photo, that can be attached to a timeline item. 893 "contentUrl": "A String", # The URL for the content. 894 "contentType": "A String", # The MIME type of the attachment. 895 "id": "A String", # The ID of the attachment. 896 "isProcessingContent": True or False, # Indicates that the contentUrl is not available because the attachment content is still being processed. If the caller wishes to retrieve the content, it should try again later. 897 }, 898 ], 899 "displayTime": "A String", # The time that should be displayed when this item is viewed in the timeline, formatted according to RFC 3339. This user's timeline is sorted chronologically on display time, so this will also determine where the item is displayed in the timeline. If not set by the service, the display time defaults to the updated time. 900 "creator": { # A person or group that can be used as a creator or a contact. # The user or group that created this item. 901 "kind": "mirror#contact", # The type of resource. This is always mirror#contact. 902 "displayName": "A String", # The name to display for this contact. 903 "acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items. 904 "A String", 905 ], 906 "imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client. 907 "A String", 908 ], 909 "priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities. 910 "source": "A String", # The ID of the application that created this contact. This is populated by the API 911 "phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number. 912 "sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are: 913 # - ADD_CAPTION 914 "A String", 915 ], 916 "type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are: 917 # - INDIVIDUAL - Represents a single person. This is the default. 918 # - GROUP - Represents more than a single person. 919 "acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command. 920 { # A single menu command that is part of a Contact. 921 "type": "A String", # The type of operation this command corresponds to. Allowed values are: 922 # - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command. 923 # - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command. 924 }, 925 ], 926 "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token. 927 "speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic. 928 }, 929 "text": "A String", # Text content of this item. 930 "menuItems": [ # A list of menu items that will be presented to the user when this item is selected in the timeline. 931 { # A custom menu item that can be presented to the user by a timeline item. 932 "contextual_command": "A String", # The ContextualMenus.Command associated with this MenuItem (e.g. READ_ALOUD). The voice label for this command will be displayed in the voice menu and the touch label will be displayed in the touch menu. Note that the default menu value's display name will be overriden if you specify this property. Values that do not correspond to a ContextualMenus.Command name will be ignored. 933 "removeWhenSelected": True or False, # If set to true on a CUSTOM menu item, that item will be removed from the menu after it is selected. 934 "payload": "A String", # A generic payload whose meaning changes depending on this MenuItem's action. 935 # - When the action is OPEN_URI, the payload is the URL of the website to view. 936 # - When the action is PLAY_VIDEO, the payload is the streaming URL of the video 937 # - When the action is GET_MEDIA_INPUT, the payload is the text transcription of a user's speech input 938 "values": [ # For CUSTOM items, a list of values controlling the appearance of the menu item in each of its states. A value for the DEFAULT state must be provided. If the PENDING or CONFIRMED states are missing, they will not be shown. 939 { # A single value that is part of a MenuItem. 940 "iconUrl": "A String", # URL of an icon to display with the menu item. 941 "state": "A String", # The state that this value applies to. Allowed values are: 942 # - DEFAULT - Default value shown when displayed in the menuItems list. 943 # - PENDING - Value shown when the menuItem has been selected by the user but can still be cancelled. 944 # - CONFIRMED - Value shown when the menuItem has been selected by the user and can no longer be cancelled. 945 "displayName": "A String", # The name to display for the menu item. If you specify this property for a built-in menu item, the default contextual voice command for that menu item is not shown. 946 }, 947 ], 948 "action": "A String", # Controls the behavior when the user picks the menu option. Allowed values are: 949 # - CUSTOM - Custom action set by the service. When the user selects this menuItem, the API triggers a notification to your callbackUrl with the userActions.type set to CUSTOM and the userActions.payload set to the ID of this menu item. This is the default value. 950 # - Built-in actions: 951 # - REPLY - Initiate a reply to the timeline item using the voice recording UI. The creator attribute must be set in the timeline item for this menu to be available. 952 # - REPLY_ALL - Same behavior as REPLY. The original timeline item's recipients will be added to the reply item. 953 # - DELETE - Delete the timeline item. 954 # - SHARE - Share the timeline item with the available contacts. 955 # - READ_ALOUD - Read the timeline item's speakableText aloud; if this field is not set, read the text field; if none of those fields are set, this menu item is ignored. 956 # - GET_MEDIA_INPUT - Allow users to provide media payloads to Glassware from a menu item (currently, only transcribed text from voice input is supported). Subscribe to notifications when users invoke this menu item to receive the timeline item ID. Retrieve the media from the timeline item in the payload property. 957 # - VOICE_CALL - Initiate a phone call using the timeline item's creator.phoneNumber attribute as recipient. 958 # - NAVIGATE - Navigate to the timeline item's location. 959 # - TOGGLE_PINNED - Toggle the isPinned state of the timeline item. 960 # - OPEN_URI - Open the payload of the menu item in the browser. 961 # - PLAY_VIDEO - Open the payload of the menu item in the Glass video player. 962 # - SEND_MESSAGE - Initiate sending a message to the timeline item's creator: 963 # - If the creator.phoneNumber is set and Glass is connected to an Android phone, the message is an SMS. 964 # - Otherwise, if the creator.email is set, the message is an email. 965 "id": "A String", # The ID for this menu item. This is generated by the application and is treated as an opaque token. 966 }, 967 ], 968 "isBundleCover": True or False, # Whether this item is a bundle cover. 969 # 970 # If an item is marked as a bundle cover, it will be the entry point to the bundle of items that have the same bundleId as that item. It will be shown only on the main timeline — not within the opened bundle. 971 # 972 # On the main timeline, items that are shown are: 973 # - Items that have isBundleCover set to true 974 # - Items that do not have a bundleId In a bundle sub-timeline, items that are shown are: 975 # - Items that have the bundleId in question AND isBundleCover set to false 976 "etag": "A String", # ETag for this item. 977 "id": "A String", # The ID of the timeline item. This is unique within a user's timeline. 978 "isDeleted": True or False, # When true, indicates this item is deleted, and only the ID property is set. 979 "bundleId": "A String", # The bundle ID for this item. Services can specify a bundleId to group many items together. They appear under a single top-level item on the device. 980 "isPinned": True or False, # When true, indicates this item is pinned, which means it's grouped alongside "active" items like navigation and hangouts, on the opposite side of the home screen from historical (non-pinned) timeline items. You can allow the user to toggle the value of this property with the TOGGLE_PINNED built-in menu item. 981 "title": "A String", # The title of this item. 982 "notification": { # Controls how notifications for a timeline item are presented to the user. # Controls how notifications for this item are presented on the device. If this is missing, no notification will be generated. 983 "level": "A String", # Describes how important the notification is. Allowed values are: 984 # - DEFAULT - Notifications of default importance. A chime will be played to alert users. 985 "deliveryTime": "A String", # The time at which the notification should be delivered. 986 }, 987 "speakableText": "A String", # The speakable version of the content of this item. Along with the READ_ALOUD menu item, use this field to provide text that would be clearer when read aloud, or to provide extended information to what is displayed visually on Glass. 988 # 989 # Glassware should also specify the speakableType field, which will be spoken before this text in cases where the additional context is useful, for example when the user requests that the item be read aloud following a notification. 990 "html": "A String", # HTML content for this item. If both text and html are provided for an item, the html will be rendered in the timeline. 991 # Allowed HTML elements - You can use these elements in your timeline cards. 992 # 993 # - Headers: h1, h2, h3, h4, h5, h6 994 # - Images: img 995 # - Lists: li, ol, ul 996 # - HTML5 semantics: article, aside, details, figure, figcaption, footer, header, nav, section, summary, time 997 # - Structural: blockquote, br, div, hr, p, span 998 # - Style: b, big, center, em, i, u, s, small, strike, strong, style, sub, sup 999 # - Tables: table, tbody, td, tfoot, th, thead, tr 1000 # Blocked HTML elements: These elements and their contents are removed from HTML payloads. 1001 # 1002 # - Document headers: head, title 1003 # - Embeds: audio, embed, object, source, video 1004 # - Frames: frame, frameset 1005 # - Scripting: applet, script 1006 # Other elements: Any elements that aren't listed are removed, but their contents are preserved. 1007 "location": { # A geographic location that can be associated with a timeline item. # The geographic location associated with this item. 1008 "kind": "mirror#location", # The type of resource. This is always mirror#location. 1009 "displayName": "A String", # The name to be displayed. This may be a business name or a user-defined place, such as "Home". 1010 "timestamp": "A String", # The time at which this location was captured, formatted according to RFC 3339. 1011 "longitude": 3.14, # The longitude, in degrees. 1012 "address": "A String", # The full address of the location. 1013 "latitude": 3.14, # The latitude, in degrees. 1014 "id": "A String", # The ID of the location. 1015 "accuracy": 3.14, # The accuracy of the location fix in meters. 1016 }, 1017 "sourceItemId": "A String", # Opaque string you can use to map a timeline item to data in your own service. 1018 "inReplyTo": "A String", # If this item was generated as a reply to another item, this field will be set to the ID of the item being replied to. This can be used to attach a reply to the appropriate conversation or post. 1019 "updated": "A String", # The time at which this item was last modified, formatted according to RFC 3339. 1020 "canonicalUrl": "A String", # A canonical URL pointing to the canonical/high quality version of the data represented by the timeline item. 1021 "recipients": [ # A list of users or groups that this item has been shared with. 1022 { # A person or group that can be used as a creator or a contact. 1023 "kind": "mirror#contact", # The type of resource. This is always mirror#contact. 1024 "displayName": "A String", # The name to display for this contact. 1025 "acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items. 1026 "A String", 1027 ], 1028 "imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client. 1029 "A String", 1030 ], 1031 "priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities. 1032 "source": "A String", # The ID of the application that created this contact. This is populated by the API 1033 "phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number. 1034 "sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are: 1035 # - ADD_CAPTION 1036 "A String", 1037 ], 1038 "type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are: 1039 # - INDIVIDUAL - Represents a single person. This is the default. 1040 # - GROUP - Represents more than a single person. 1041 "acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command. 1042 { # A single menu command that is part of a Contact. 1043 "type": "A String", # The type of operation this command corresponds to. Allowed values are: 1044 # - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command. 1045 # - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command. 1046 }, 1047 ], 1048 "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token. 1049 "speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic. 1050 }, 1051 ], 1052 "kind": "mirror#timelineItem", # The type of resource. This is always mirror#timelineItem. 1053 "created": "A String", # The time at which this item was created, formatted according to RFC 3339. 1054 "pinScore": 42, # For pinned items, this determines the order in which the item is displayed in the timeline, with a higher score appearing closer to the clock. Note: setting this field is currently not supported. 1055 "speakableType": "A String", # A speakable description of the type of this item. This will be announced to the user prior to reading the content of the item in cases where the additional context is useful, for example when the user requests that the item be read aloud following a notification. 1056 # 1057 # This should be a short, simple noun phrase such as "Email", "Text message", or "Daily Planet News Update". 1058 # 1059 # Glassware are encouraged to populate this field for every timeline item, even if the item does not contain speakableText or text so that the user can learn the type of the item without looking at the screen. 1060 "selfLink": "A String", # A URL that can be used to retrieve this item. 1061 } 1062 1063 1064Returns: 1065 An object of the form: 1066 1067 { # Each item in the user's timeline is represented as a TimelineItem JSON structure, described below. 1068 "attachments": [ # A list of media attachments associated with this item. As a convenience, you can refer to attachments in your HTML payloads with the attachment or cid scheme. For example: 1069 # - attachment: <img src="attachment:attachment_index"> where attachment_index is the 0-based index of this array. 1070 # - cid: <img src="cid:attachment_id"> where attachment_id is the ID of the attachment. 1071 { # Represents media content, such as a photo, that can be attached to a timeline item. 1072 "contentUrl": "A String", # The URL for the content. 1073 "contentType": "A String", # The MIME type of the attachment. 1074 "id": "A String", # The ID of the attachment. 1075 "isProcessingContent": True or False, # Indicates that the contentUrl is not available because the attachment content is still being processed. If the caller wishes to retrieve the content, it should try again later. 1076 }, 1077 ], 1078 "displayTime": "A String", # The time that should be displayed when this item is viewed in the timeline, formatted according to RFC 3339. This user's timeline is sorted chronologically on display time, so this will also determine where the item is displayed in the timeline. If not set by the service, the display time defaults to the updated time. 1079 "creator": { # A person or group that can be used as a creator or a contact. # The user or group that created this item. 1080 "kind": "mirror#contact", # The type of resource. This is always mirror#contact. 1081 "displayName": "A String", # The name to display for this contact. 1082 "acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items. 1083 "A String", 1084 ], 1085 "imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client. 1086 "A String", 1087 ], 1088 "priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities. 1089 "source": "A String", # The ID of the application that created this contact. This is populated by the API 1090 "phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number. 1091 "sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are: 1092 # - ADD_CAPTION 1093 "A String", 1094 ], 1095 "type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are: 1096 # - INDIVIDUAL - Represents a single person. This is the default. 1097 # - GROUP - Represents more than a single person. 1098 "acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command. 1099 { # A single menu command that is part of a Contact. 1100 "type": "A String", # The type of operation this command corresponds to. Allowed values are: 1101 # - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command. 1102 # - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command. 1103 }, 1104 ], 1105 "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token. 1106 "speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic. 1107 }, 1108 "text": "A String", # Text content of this item. 1109 "menuItems": [ # A list of menu items that will be presented to the user when this item is selected in the timeline. 1110 { # A custom menu item that can be presented to the user by a timeline item. 1111 "contextual_command": "A String", # The ContextualMenus.Command associated with this MenuItem (e.g. READ_ALOUD). The voice label for this command will be displayed in the voice menu and the touch label will be displayed in the touch menu. Note that the default menu value's display name will be overriden if you specify this property. Values that do not correspond to a ContextualMenus.Command name will be ignored. 1112 "removeWhenSelected": True or False, # If set to true on a CUSTOM menu item, that item will be removed from the menu after it is selected. 1113 "payload": "A String", # A generic payload whose meaning changes depending on this MenuItem's action. 1114 # - When the action is OPEN_URI, the payload is the URL of the website to view. 1115 # - When the action is PLAY_VIDEO, the payload is the streaming URL of the video 1116 # - When the action is GET_MEDIA_INPUT, the payload is the text transcription of a user's speech input 1117 "values": [ # For CUSTOM items, a list of values controlling the appearance of the menu item in each of its states. A value for the DEFAULT state must be provided. If the PENDING or CONFIRMED states are missing, they will not be shown. 1118 { # A single value that is part of a MenuItem. 1119 "iconUrl": "A String", # URL of an icon to display with the menu item. 1120 "state": "A String", # The state that this value applies to. Allowed values are: 1121 # - DEFAULT - Default value shown when displayed in the menuItems list. 1122 # - PENDING - Value shown when the menuItem has been selected by the user but can still be cancelled. 1123 # - CONFIRMED - Value shown when the menuItem has been selected by the user and can no longer be cancelled. 1124 "displayName": "A String", # The name to display for the menu item. If you specify this property for a built-in menu item, the default contextual voice command for that menu item is not shown. 1125 }, 1126 ], 1127 "action": "A String", # Controls the behavior when the user picks the menu option. Allowed values are: 1128 # - CUSTOM - Custom action set by the service. When the user selects this menuItem, the API triggers a notification to your callbackUrl with the userActions.type set to CUSTOM and the userActions.payload set to the ID of this menu item. This is the default value. 1129 # - Built-in actions: 1130 # - REPLY - Initiate a reply to the timeline item using the voice recording UI. The creator attribute must be set in the timeline item for this menu to be available. 1131 # - REPLY_ALL - Same behavior as REPLY. The original timeline item's recipients will be added to the reply item. 1132 # - DELETE - Delete the timeline item. 1133 # - SHARE - Share the timeline item with the available contacts. 1134 # - READ_ALOUD - Read the timeline item's speakableText aloud; if this field is not set, read the text field; if none of those fields are set, this menu item is ignored. 1135 # - GET_MEDIA_INPUT - Allow users to provide media payloads to Glassware from a menu item (currently, only transcribed text from voice input is supported). Subscribe to notifications when users invoke this menu item to receive the timeline item ID. Retrieve the media from the timeline item in the payload property. 1136 # - VOICE_CALL - Initiate a phone call using the timeline item's creator.phoneNumber attribute as recipient. 1137 # - NAVIGATE - Navigate to the timeline item's location. 1138 # - TOGGLE_PINNED - Toggle the isPinned state of the timeline item. 1139 # - OPEN_URI - Open the payload of the menu item in the browser. 1140 # - PLAY_VIDEO - Open the payload of the menu item in the Glass video player. 1141 # - SEND_MESSAGE - Initiate sending a message to the timeline item's creator: 1142 # - If the creator.phoneNumber is set and Glass is connected to an Android phone, the message is an SMS. 1143 # - Otherwise, if the creator.email is set, the message is an email. 1144 "id": "A String", # The ID for this menu item. This is generated by the application and is treated as an opaque token. 1145 }, 1146 ], 1147 "isBundleCover": True or False, # Whether this item is a bundle cover. 1148 # 1149 # If an item is marked as a bundle cover, it will be the entry point to the bundle of items that have the same bundleId as that item. It will be shown only on the main timeline — not within the opened bundle. 1150 # 1151 # On the main timeline, items that are shown are: 1152 # - Items that have isBundleCover set to true 1153 # - Items that do not have a bundleId In a bundle sub-timeline, items that are shown are: 1154 # - Items that have the bundleId in question AND isBundleCover set to false 1155 "etag": "A String", # ETag for this item. 1156 "id": "A String", # The ID of the timeline item. This is unique within a user's timeline. 1157 "isDeleted": True or False, # When true, indicates this item is deleted, and only the ID property is set. 1158 "bundleId": "A String", # The bundle ID for this item. Services can specify a bundleId to group many items together. They appear under a single top-level item on the device. 1159 "isPinned": True or False, # When true, indicates this item is pinned, which means it's grouped alongside "active" items like navigation and hangouts, on the opposite side of the home screen from historical (non-pinned) timeline items. You can allow the user to toggle the value of this property with the TOGGLE_PINNED built-in menu item. 1160 "title": "A String", # The title of this item. 1161 "notification": { # Controls how notifications for a timeline item are presented to the user. # Controls how notifications for this item are presented on the device. If this is missing, no notification will be generated. 1162 "level": "A String", # Describes how important the notification is. Allowed values are: 1163 # - DEFAULT - Notifications of default importance. A chime will be played to alert users. 1164 "deliveryTime": "A String", # The time at which the notification should be delivered. 1165 }, 1166 "speakableText": "A String", # The speakable version of the content of this item. Along with the READ_ALOUD menu item, use this field to provide text that would be clearer when read aloud, or to provide extended information to what is displayed visually on Glass. 1167 # 1168 # Glassware should also specify the speakableType field, which will be spoken before this text in cases where the additional context is useful, for example when the user requests that the item be read aloud following a notification. 1169 "html": "A String", # HTML content for this item. If both text and html are provided for an item, the html will be rendered in the timeline. 1170 # Allowed HTML elements - You can use these elements in your timeline cards. 1171 # 1172 # - Headers: h1, h2, h3, h4, h5, h6 1173 # - Images: img 1174 # - Lists: li, ol, ul 1175 # - HTML5 semantics: article, aside, details, figure, figcaption, footer, header, nav, section, summary, time 1176 # - Structural: blockquote, br, div, hr, p, span 1177 # - Style: b, big, center, em, i, u, s, small, strike, strong, style, sub, sup 1178 # - Tables: table, tbody, td, tfoot, th, thead, tr 1179 # Blocked HTML elements: These elements and their contents are removed from HTML payloads. 1180 # 1181 # - Document headers: head, title 1182 # - Embeds: audio, embed, object, source, video 1183 # - Frames: frame, frameset 1184 # - Scripting: applet, script 1185 # Other elements: Any elements that aren't listed are removed, but their contents are preserved. 1186 "location": { # A geographic location that can be associated with a timeline item. # The geographic location associated with this item. 1187 "kind": "mirror#location", # The type of resource. This is always mirror#location. 1188 "displayName": "A String", # The name to be displayed. This may be a business name or a user-defined place, such as "Home". 1189 "timestamp": "A String", # The time at which this location was captured, formatted according to RFC 3339. 1190 "longitude": 3.14, # The longitude, in degrees. 1191 "address": "A String", # The full address of the location. 1192 "latitude": 3.14, # The latitude, in degrees. 1193 "id": "A String", # The ID of the location. 1194 "accuracy": 3.14, # The accuracy of the location fix in meters. 1195 }, 1196 "sourceItemId": "A String", # Opaque string you can use to map a timeline item to data in your own service. 1197 "inReplyTo": "A String", # If this item was generated as a reply to another item, this field will be set to the ID of the item being replied to. This can be used to attach a reply to the appropriate conversation or post. 1198 "updated": "A String", # The time at which this item was last modified, formatted according to RFC 3339. 1199 "canonicalUrl": "A String", # A canonical URL pointing to the canonical/high quality version of the data represented by the timeline item. 1200 "recipients": [ # A list of users or groups that this item has been shared with. 1201 { # A person or group that can be used as a creator or a contact. 1202 "kind": "mirror#contact", # The type of resource. This is always mirror#contact. 1203 "displayName": "A String", # The name to display for this contact. 1204 "acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items. 1205 "A String", 1206 ], 1207 "imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client. 1208 "A String", 1209 ], 1210 "priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities. 1211 "source": "A String", # The ID of the application that created this contact. This is populated by the API 1212 "phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number. 1213 "sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are: 1214 # - ADD_CAPTION 1215 "A String", 1216 ], 1217 "type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are: 1218 # - INDIVIDUAL - Represents a single person. This is the default. 1219 # - GROUP - Represents more than a single person. 1220 "acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command. 1221 { # A single menu command that is part of a Contact. 1222 "type": "A String", # The type of operation this command corresponds to. Allowed values are: 1223 # - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command. 1224 # - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command. 1225 }, 1226 ], 1227 "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token. 1228 "speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic. 1229 }, 1230 ], 1231 "kind": "mirror#timelineItem", # The type of resource. This is always mirror#timelineItem. 1232 "created": "A String", # The time at which this item was created, formatted according to RFC 3339. 1233 "pinScore": 42, # For pinned items, this determines the order in which the item is displayed in the timeline, with a higher score appearing closer to the clock. Note: setting this field is currently not supported. 1234 "speakableType": "A String", # A speakable description of the type of this item. This will be announced to the user prior to reading the content of the item in cases where the additional context is useful, for example when the user requests that the item be read aloud following a notification. 1235 # 1236 # This should be a short, simple noun phrase such as "Email", "Text message", or "Daily Planet News Update". 1237 # 1238 # Glassware are encouraged to populate this field for every timeline item, even if the item does not contain speakableText or text so that the user can learn the type of the item without looking at the screen. 1239 "selfLink": "A String", # A URL that can be used to retrieve this item. 1240 }</pre> 1241</div> 1242 1243<div class="method"> 1244 <code class="details" id="update">update(id, body=None, media_body=None, media_mime_type=None)</code> 1245 <pre>Updates a timeline item in place. 1246 1247Args: 1248 id: string, The ID of the timeline item. (required) 1249 body: object, The request body. 1250 The object takes the form of: 1251 1252{ # Each item in the user's timeline is represented as a TimelineItem JSON structure, described below. 1253 "attachments": [ # A list of media attachments associated with this item. As a convenience, you can refer to attachments in your HTML payloads with the attachment or cid scheme. For example: 1254 # - attachment: <img src="attachment:attachment_index"> where attachment_index is the 0-based index of this array. 1255 # - cid: <img src="cid:attachment_id"> where attachment_id is the ID of the attachment. 1256 { # Represents media content, such as a photo, that can be attached to a timeline item. 1257 "contentUrl": "A String", # The URL for the content. 1258 "contentType": "A String", # The MIME type of the attachment. 1259 "id": "A String", # The ID of the attachment. 1260 "isProcessingContent": True or False, # Indicates that the contentUrl is not available because the attachment content is still being processed. If the caller wishes to retrieve the content, it should try again later. 1261 }, 1262 ], 1263 "displayTime": "A String", # The time that should be displayed when this item is viewed in the timeline, formatted according to RFC 3339. This user's timeline is sorted chronologically on display time, so this will also determine where the item is displayed in the timeline. If not set by the service, the display time defaults to the updated time. 1264 "creator": { # A person or group that can be used as a creator or a contact. # The user or group that created this item. 1265 "kind": "mirror#contact", # The type of resource. This is always mirror#contact. 1266 "displayName": "A String", # The name to display for this contact. 1267 "acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items. 1268 "A String", 1269 ], 1270 "imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client. 1271 "A String", 1272 ], 1273 "priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities. 1274 "source": "A String", # The ID of the application that created this contact. This is populated by the API 1275 "phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number. 1276 "sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are: 1277 # - ADD_CAPTION 1278 "A String", 1279 ], 1280 "type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are: 1281 # - INDIVIDUAL - Represents a single person. This is the default. 1282 # - GROUP - Represents more than a single person. 1283 "acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command. 1284 { # A single menu command that is part of a Contact. 1285 "type": "A String", # The type of operation this command corresponds to. Allowed values are: 1286 # - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command. 1287 # - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command. 1288 }, 1289 ], 1290 "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token. 1291 "speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic. 1292 }, 1293 "text": "A String", # Text content of this item. 1294 "menuItems": [ # A list of menu items that will be presented to the user when this item is selected in the timeline. 1295 { # A custom menu item that can be presented to the user by a timeline item. 1296 "contextual_command": "A String", # The ContextualMenus.Command associated with this MenuItem (e.g. READ_ALOUD). The voice label for this command will be displayed in the voice menu and the touch label will be displayed in the touch menu. Note that the default menu value's display name will be overriden if you specify this property. Values that do not correspond to a ContextualMenus.Command name will be ignored. 1297 "removeWhenSelected": True or False, # If set to true on a CUSTOM menu item, that item will be removed from the menu after it is selected. 1298 "payload": "A String", # A generic payload whose meaning changes depending on this MenuItem's action. 1299 # - When the action is OPEN_URI, the payload is the URL of the website to view. 1300 # - When the action is PLAY_VIDEO, the payload is the streaming URL of the video 1301 # - When the action is GET_MEDIA_INPUT, the payload is the text transcription of a user's speech input 1302 "values": [ # For CUSTOM items, a list of values controlling the appearance of the menu item in each of its states. A value for the DEFAULT state must be provided. If the PENDING or CONFIRMED states are missing, they will not be shown. 1303 { # A single value that is part of a MenuItem. 1304 "iconUrl": "A String", # URL of an icon to display with the menu item. 1305 "state": "A String", # The state that this value applies to. Allowed values are: 1306 # - DEFAULT - Default value shown when displayed in the menuItems list. 1307 # - PENDING - Value shown when the menuItem has been selected by the user but can still be cancelled. 1308 # - CONFIRMED - Value shown when the menuItem has been selected by the user and can no longer be cancelled. 1309 "displayName": "A String", # The name to display for the menu item. If you specify this property for a built-in menu item, the default contextual voice command for that menu item is not shown. 1310 }, 1311 ], 1312 "action": "A String", # Controls the behavior when the user picks the menu option. Allowed values are: 1313 # - CUSTOM - Custom action set by the service. When the user selects this menuItem, the API triggers a notification to your callbackUrl with the userActions.type set to CUSTOM and the userActions.payload set to the ID of this menu item. This is the default value. 1314 # - Built-in actions: 1315 # - REPLY - Initiate a reply to the timeline item using the voice recording UI. The creator attribute must be set in the timeline item for this menu to be available. 1316 # - REPLY_ALL - Same behavior as REPLY. The original timeline item's recipients will be added to the reply item. 1317 # - DELETE - Delete the timeline item. 1318 # - SHARE - Share the timeline item with the available contacts. 1319 # - READ_ALOUD - Read the timeline item's speakableText aloud; if this field is not set, read the text field; if none of those fields are set, this menu item is ignored. 1320 # - GET_MEDIA_INPUT - Allow users to provide media payloads to Glassware from a menu item (currently, only transcribed text from voice input is supported). Subscribe to notifications when users invoke this menu item to receive the timeline item ID. Retrieve the media from the timeline item in the payload property. 1321 # - VOICE_CALL - Initiate a phone call using the timeline item's creator.phoneNumber attribute as recipient. 1322 # - NAVIGATE - Navigate to the timeline item's location. 1323 # - TOGGLE_PINNED - Toggle the isPinned state of the timeline item. 1324 # - OPEN_URI - Open the payload of the menu item in the browser. 1325 # - PLAY_VIDEO - Open the payload of the menu item in the Glass video player. 1326 # - SEND_MESSAGE - Initiate sending a message to the timeline item's creator: 1327 # - If the creator.phoneNumber is set and Glass is connected to an Android phone, the message is an SMS. 1328 # - Otherwise, if the creator.email is set, the message is an email. 1329 "id": "A String", # The ID for this menu item. This is generated by the application and is treated as an opaque token. 1330 }, 1331 ], 1332 "isBundleCover": True or False, # Whether this item is a bundle cover. 1333 # 1334 # If an item is marked as a bundle cover, it will be the entry point to the bundle of items that have the same bundleId as that item. It will be shown only on the main timeline — not within the opened bundle. 1335 # 1336 # On the main timeline, items that are shown are: 1337 # - Items that have isBundleCover set to true 1338 # - Items that do not have a bundleId In a bundle sub-timeline, items that are shown are: 1339 # - Items that have the bundleId in question AND isBundleCover set to false 1340 "etag": "A String", # ETag for this item. 1341 "id": "A String", # The ID of the timeline item. This is unique within a user's timeline. 1342 "isDeleted": True or False, # When true, indicates this item is deleted, and only the ID property is set. 1343 "bundleId": "A String", # The bundle ID for this item. Services can specify a bundleId to group many items together. They appear under a single top-level item on the device. 1344 "isPinned": True or False, # When true, indicates this item is pinned, which means it's grouped alongside "active" items like navigation and hangouts, on the opposite side of the home screen from historical (non-pinned) timeline items. You can allow the user to toggle the value of this property with the TOGGLE_PINNED built-in menu item. 1345 "title": "A String", # The title of this item. 1346 "notification": { # Controls how notifications for a timeline item are presented to the user. # Controls how notifications for this item are presented on the device. If this is missing, no notification will be generated. 1347 "level": "A String", # Describes how important the notification is. Allowed values are: 1348 # - DEFAULT - Notifications of default importance. A chime will be played to alert users. 1349 "deliveryTime": "A String", # The time at which the notification should be delivered. 1350 }, 1351 "speakableText": "A String", # The speakable version of the content of this item. Along with the READ_ALOUD menu item, use this field to provide text that would be clearer when read aloud, or to provide extended information to what is displayed visually on Glass. 1352 # 1353 # Glassware should also specify the speakableType field, which will be spoken before this text in cases where the additional context is useful, for example when the user requests that the item be read aloud following a notification. 1354 "html": "A String", # HTML content for this item. If both text and html are provided for an item, the html will be rendered in the timeline. 1355 # Allowed HTML elements - You can use these elements in your timeline cards. 1356 # 1357 # - Headers: h1, h2, h3, h4, h5, h6 1358 # - Images: img 1359 # - Lists: li, ol, ul 1360 # - HTML5 semantics: article, aside, details, figure, figcaption, footer, header, nav, section, summary, time 1361 # - Structural: blockquote, br, div, hr, p, span 1362 # - Style: b, big, center, em, i, u, s, small, strike, strong, style, sub, sup 1363 # - Tables: table, tbody, td, tfoot, th, thead, tr 1364 # Blocked HTML elements: These elements and their contents are removed from HTML payloads. 1365 # 1366 # - Document headers: head, title 1367 # - Embeds: audio, embed, object, source, video 1368 # - Frames: frame, frameset 1369 # - Scripting: applet, script 1370 # Other elements: Any elements that aren't listed are removed, but their contents are preserved. 1371 "location": { # A geographic location that can be associated with a timeline item. # The geographic location associated with this item. 1372 "kind": "mirror#location", # The type of resource. This is always mirror#location. 1373 "displayName": "A String", # The name to be displayed. This may be a business name or a user-defined place, such as "Home". 1374 "timestamp": "A String", # The time at which this location was captured, formatted according to RFC 3339. 1375 "longitude": 3.14, # The longitude, in degrees. 1376 "address": "A String", # The full address of the location. 1377 "latitude": 3.14, # The latitude, in degrees. 1378 "id": "A String", # The ID of the location. 1379 "accuracy": 3.14, # The accuracy of the location fix in meters. 1380 }, 1381 "sourceItemId": "A String", # Opaque string you can use to map a timeline item to data in your own service. 1382 "inReplyTo": "A String", # If this item was generated as a reply to another item, this field will be set to the ID of the item being replied to. This can be used to attach a reply to the appropriate conversation or post. 1383 "updated": "A String", # The time at which this item was last modified, formatted according to RFC 3339. 1384 "canonicalUrl": "A String", # A canonical URL pointing to the canonical/high quality version of the data represented by the timeline item. 1385 "recipients": [ # A list of users or groups that this item has been shared with. 1386 { # A person or group that can be used as a creator or a contact. 1387 "kind": "mirror#contact", # The type of resource. This is always mirror#contact. 1388 "displayName": "A String", # The name to display for this contact. 1389 "acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items. 1390 "A String", 1391 ], 1392 "imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client. 1393 "A String", 1394 ], 1395 "priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities. 1396 "source": "A String", # The ID of the application that created this contact. This is populated by the API 1397 "phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number. 1398 "sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are: 1399 # - ADD_CAPTION 1400 "A String", 1401 ], 1402 "type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are: 1403 # - INDIVIDUAL - Represents a single person. This is the default. 1404 # - GROUP - Represents more than a single person. 1405 "acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command. 1406 { # A single menu command that is part of a Contact. 1407 "type": "A String", # The type of operation this command corresponds to. Allowed values are: 1408 # - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command. 1409 # - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command. 1410 }, 1411 ], 1412 "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token. 1413 "speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic. 1414 }, 1415 ], 1416 "kind": "mirror#timelineItem", # The type of resource. This is always mirror#timelineItem. 1417 "created": "A String", # The time at which this item was created, formatted according to RFC 3339. 1418 "pinScore": 42, # For pinned items, this determines the order in which the item is displayed in the timeline, with a higher score appearing closer to the clock. Note: setting this field is currently not supported. 1419 "speakableType": "A String", # A speakable description of the type of this item. This will be announced to the user prior to reading the content of the item in cases where the additional context is useful, for example when the user requests that the item be read aloud following a notification. 1420 # 1421 # This should be a short, simple noun phrase such as "Email", "Text message", or "Daily Planet News Update". 1422 # 1423 # Glassware are encouraged to populate this field for every timeline item, even if the item does not contain speakableText or text so that the user can learn the type of the item without looking at the screen. 1424 "selfLink": "A String", # A URL that can be used to retrieve this item. 1425 } 1426 1427 media_body: string, The filename of the media request body, or an instance of a MediaUpload object. 1428 media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object. 1429 1430Returns: 1431 An object of the form: 1432 1433 { # Each item in the user's timeline is represented as a TimelineItem JSON structure, described below. 1434 "attachments": [ # A list of media attachments associated with this item. As a convenience, you can refer to attachments in your HTML payloads with the attachment or cid scheme. For example: 1435 # - attachment: <img src="attachment:attachment_index"> where attachment_index is the 0-based index of this array. 1436 # - cid: <img src="cid:attachment_id"> where attachment_id is the ID of the attachment. 1437 { # Represents media content, such as a photo, that can be attached to a timeline item. 1438 "contentUrl": "A String", # The URL for the content. 1439 "contentType": "A String", # The MIME type of the attachment. 1440 "id": "A String", # The ID of the attachment. 1441 "isProcessingContent": True or False, # Indicates that the contentUrl is not available because the attachment content is still being processed. If the caller wishes to retrieve the content, it should try again later. 1442 }, 1443 ], 1444 "displayTime": "A String", # The time that should be displayed when this item is viewed in the timeline, formatted according to RFC 3339. This user's timeline is sorted chronologically on display time, so this will also determine where the item is displayed in the timeline. If not set by the service, the display time defaults to the updated time. 1445 "creator": { # A person or group that can be used as a creator or a contact. # The user or group that created this item. 1446 "kind": "mirror#contact", # The type of resource. This is always mirror#contact. 1447 "displayName": "A String", # The name to display for this contact. 1448 "acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items. 1449 "A String", 1450 ], 1451 "imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client. 1452 "A String", 1453 ], 1454 "priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities. 1455 "source": "A String", # The ID of the application that created this contact. This is populated by the API 1456 "phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number. 1457 "sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are: 1458 # - ADD_CAPTION 1459 "A String", 1460 ], 1461 "type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are: 1462 # - INDIVIDUAL - Represents a single person. This is the default. 1463 # - GROUP - Represents more than a single person. 1464 "acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command. 1465 { # A single menu command that is part of a Contact. 1466 "type": "A String", # The type of operation this command corresponds to. Allowed values are: 1467 # - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command. 1468 # - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command. 1469 }, 1470 ], 1471 "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token. 1472 "speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic. 1473 }, 1474 "text": "A String", # Text content of this item. 1475 "menuItems": [ # A list of menu items that will be presented to the user when this item is selected in the timeline. 1476 { # A custom menu item that can be presented to the user by a timeline item. 1477 "contextual_command": "A String", # The ContextualMenus.Command associated with this MenuItem (e.g. READ_ALOUD). The voice label for this command will be displayed in the voice menu and the touch label will be displayed in the touch menu. Note that the default menu value's display name will be overriden if you specify this property. Values that do not correspond to a ContextualMenus.Command name will be ignored. 1478 "removeWhenSelected": True or False, # If set to true on a CUSTOM menu item, that item will be removed from the menu after it is selected. 1479 "payload": "A String", # A generic payload whose meaning changes depending on this MenuItem's action. 1480 # - When the action is OPEN_URI, the payload is the URL of the website to view. 1481 # - When the action is PLAY_VIDEO, the payload is the streaming URL of the video 1482 # - When the action is GET_MEDIA_INPUT, the payload is the text transcription of a user's speech input 1483 "values": [ # For CUSTOM items, a list of values controlling the appearance of the menu item in each of its states. A value for the DEFAULT state must be provided. If the PENDING or CONFIRMED states are missing, they will not be shown. 1484 { # A single value that is part of a MenuItem. 1485 "iconUrl": "A String", # URL of an icon to display with the menu item. 1486 "state": "A String", # The state that this value applies to. Allowed values are: 1487 # - DEFAULT - Default value shown when displayed in the menuItems list. 1488 # - PENDING - Value shown when the menuItem has been selected by the user but can still be cancelled. 1489 # - CONFIRMED - Value shown when the menuItem has been selected by the user and can no longer be cancelled. 1490 "displayName": "A String", # The name to display for the menu item. If you specify this property for a built-in menu item, the default contextual voice command for that menu item is not shown. 1491 }, 1492 ], 1493 "action": "A String", # Controls the behavior when the user picks the menu option. Allowed values are: 1494 # - CUSTOM - Custom action set by the service. When the user selects this menuItem, the API triggers a notification to your callbackUrl with the userActions.type set to CUSTOM and the userActions.payload set to the ID of this menu item. This is the default value. 1495 # - Built-in actions: 1496 # - REPLY - Initiate a reply to the timeline item using the voice recording UI. The creator attribute must be set in the timeline item for this menu to be available. 1497 # - REPLY_ALL - Same behavior as REPLY. The original timeline item's recipients will be added to the reply item. 1498 # - DELETE - Delete the timeline item. 1499 # - SHARE - Share the timeline item with the available contacts. 1500 # - READ_ALOUD - Read the timeline item's speakableText aloud; if this field is not set, read the text field; if none of those fields are set, this menu item is ignored. 1501 # - GET_MEDIA_INPUT - Allow users to provide media payloads to Glassware from a menu item (currently, only transcribed text from voice input is supported). Subscribe to notifications when users invoke this menu item to receive the timeline item ID. Retrieve the media from the timeline item in the payload property. 1502 # - VOICE_CALL - Initiate a phone call using the timeline item's creator.phoneNumber attribute as recipient. 1503 # - NAVIGATE - Navigate to the timeline item's location. 1504 # - TOGGLE_PINNED - Toggle the isPinned state of the timeline item. 1505 # - OPEN_URI - Open the payload of the menu item in the browser. 1506 # - PLAY_VIDEO - Open the payload of the menu item in the Glass video player. 1507 # - SEND_MESSAGE - Initiate sending a message to the timeline item's creator: 1508 # - If the creator.phoneNumber is set and Glass is connected to an Android phone, the message is an SMS. 1509 # - Otherwise, if the creator.email is set, the message is an email. 1510 "id": "A String", # The ID for this menu item. This is generated by the application and is treated as an opaque token. 1511 }, 1512 ], 1513 "isBundleCover": True or False, # Whether this item is a bundle cover. 1514 # 1515 # If an item is marked as a bundle cover, it will be the entry point to the bundle of items that have the same bundleId as that item. It will be shown only on the main timeline — not within the opened bundle. 1516 # 1517 # On the main timeline, items that are shown are: 1518 # - Items that have isBundleCover set to true 1519 # - Items that do not have a bundleId In a bundle sub-timeline, items that are shown are: 1520 # - Items that have the bundleId in question AND isBundleCover set to false 1521 "etag": "A String", # ETag for this item. 1522 "id": "A String", # The ID of the timeline item. This is unique within a user's timeline. 1523 "isDeleted": True or False, # When true, indicates this item is deleted, and only the ID property is set. 1524 "bundleId": "A String", # The bundle ID for this item. Services can specify a bundleId to group many items together. They appear under a single top-level item on the device. 1525 "isPinned": True or False, # When true, indicates this item is pinned, which means it's grouped alongside "active" items like navigation and hangouts, on the opposite side of the home screen from historical (non-pinned) timeline items. You can allow the user to toggle the value of this property with the TOGGLE_PINNED built-in menu item. 1526 "title": "A String", # The title of this item. 1527 "notification": { # Controls how notifications for a timeline item are presented to the user. # Controls how notifications for this item are presented on the device. If this is missing, no notification will be generated. 1528 "level": "A String", # Describes how important the notification is. Allowed values are: 1529 # - DEFAULT - Notifications of default importance. A chime will be played to alert users. 1530 "deliveryTime": "A String", # The time at which the notification should be delivered. 1531 }, 1532 "speakableText": "A String", # The speakable version of the content of this item. Along with the READ_ALOUD menu item, use this field to provide text that would be clearer when read aloud, or to provide extended information to what is displayed visually on Glass. 1533 # 1534 # Glassware should also specify the speakableType field, which will be spoken before this text in cases where the additional context is useful, for example when the user requests that the item be read aloud following a notification. 1535 "html": "A String", # HTML content for this item. If both text and html are provided for an item, the html will be rendered in the timeline. 1536 # Allowed HTML elements - You can use these elements in your timeline cards. 1537 # 1538 # - Headers: h1, h2, h3, h4, h5, h6 1539 # - Images: img 1540 # - Lists: li, ol, ul 1541 # - HTML5 semantics: article, aside, details, figure, figcaption, footer, header, nav, section, summary, time 1542 # - Structural: blockquote, br, div, hr, p, span 1543 # - Style: b, big, center, em, i, u, s, small, strike, strong, style, sub, sup 1544 # - Tables: table, tbody, td, tfoot, th, thead, tr 1545 # Blocked HTML elements: These elements and their contents are removed from HTML payloads. 1546 # 1547 # - Document headers: head, title 1548 # - Embeds: audio, embed, object, source, video 1549 # - Frames: frame, frameset 1550 # - Scripting: applet, script 1551 # Other elements: Any elements that aren't listed are removed, but their contents are preserved. 1552 "location": { # A geographic location that can be associated with a timeline item. # The geographic location associated with this item. 1553 "kind": "mirror#location", # The type of resource. This is always mirror#location. 1554 "displayName": "A String", # The name to be displayed. This may be a business name or a user-defined place, such as "Home". 1555 "timestamp": "A String", # The time at which this location was captured, formatted according to RFC 3339. 1556 "longitude": 3.14, # The longitude, in degrees. 1557 "address": "A String", # The full address of the location. 1558 "latitude": 3.14, # The latitude, in degrees. 1559 "id": "A String", # The ID of the location. 1560 "accuracy": 3.14, # The accuracy of the location fix in meters. 1561 }, 1562 "sourceItemId": "A String", # Opaque string you can use to map a timeline item to data in your own service. 1563 "inReplyTo": "A String", # If this item was generated as a reply to another item, this field will be set to the ID of the item being replied to. This can be used to attach a reply to the appropriate conversation or post. 1564 "updated": "A String", # The time at which this item was last modified, formatted according to RFC 3339. 1565 "canonicalUrl": "A String", # A canonical URL pointing to the canonical/high quality version of the data represented by the timeline item. 1566 "recipients": [ # A list of users or groups that this item has been shared with. 1567 { # A person or group that can be used as a creator or a contact. 1568 "kind": "mirror#contact", # The type of resource. This is always mirror#contact. 1569 "displayName": "A String", # The name to display for this contact. 1570 "acceptTypes": [ # A list of MIME types that a contact supports. The contact will be shown to the user if any of its acceptTypes matches any of the types of the attachments on the item. If no acceptTypes are given, the contact will be shown for all items. 1571 "A String", 1572 ], 1573 "imageUrls": [ # Set of image URLs to display for a contact. Most contacts will have a single image, but a "group" contact may include up to 8 image URLs and they will be resized and cropped into a mosaic on the client. 1574 "A String", 1575 ], 1576 "priority": 42, # Priority for the contact to determine ordering in a list of contacts. Contacts with higher priorities will be shown before ones with lower priorities. 1577 "source": "A String", # The ID of the application that created this contact. This is populated by the API 1578 "phoneNumber": "A String", # Primary phone number for the contact. This can be a fully-qualified number, with country calling code and area code, or a local number. 1579 "sharingFeatures": [ # A list of sharing features that a contact can handle. Allowed values are: 1580 # - ADD_CAPTION 1581 "A String", 1582 ], 1583 "type": "A String", # The type for this contact. This is used for sorting in UIs. Allowed values are: 1584 # - INDIVIDUAL - Represents a single person. This is the default. 1585 # - GROUP - Represents more than a single person. 1586 "acceptCommands": [ # A list of voice menu commands that a contact can handle. Glass shows up to three contacts for each voice menu command. If there are more than that, the three contacts with the highest priority are shown for that particular command. 1587 { # A single menu command that is part of a Contact. 1588 "type": "A String", # The type of operation this command corresponds to. Allowed values are: 1589 # - TAKE_A_NOTE - Shares a timeline item with the transcription of user speech from the "Take a note" voice menu command. 1590 # - POST_AN_UPDATE - Shares a timeline item with the transcription of user speech from the "Post an update" voice menu command. 1591 }, 1592 ], 1593 "id": "A String", # An ID for this contact. This is generated by the application and is treated as an opaque token. 1594 "speakableName": "A String", # Name of this contact as it should be pronounced. If this contact's name must be spoken as part of a voice disambiguation menu, this name is used as the expected pronunciation. This is useful for contact names with unpronounceable characters or whose display spelling is otherwise not phonetic. 1595 }, 1596 ], 1597 "kind": "mirror#timelineItem", # The type of resource. This is always mirror#timelineItem. 1598 "created": "A String", # The time at which this item was created, formatted according to RFC 3339. 1599 "pinScore": 42, # For pinned items, this determines the order in which the item is displayed in the timeline, with a higher score appearing closer to the clock. Note: setting this field is currently not supported. 1600 "speakableType": "A String", # A speakable description of the type of this item. This will be announced to the user prior to reading the content of the item in cases where the additional context is useful, for example when the user requests that the item be read aloud following a notification. 1601 # 1602 # This should be a short, simple noun phrase such as "Email", "Text message", or "Daily Planet News Update". 1603 # 1604 # Glassware are encouraged to populate this field for every timeline item, even if the item does not contain speakableText or text so that the user can learn the type of the item without looking at the screen. 1605 "selfLink": "A String", # A URL that can be used to retrieve this item. 1606 }</pre> 1607</div> 1608 1609</body></html>