1 <html><body> 2 <style> 3 4 body, 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 15 body { 16 font-size: 13px; 17 padding: 1em; 18 } 19 20 h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23 } 24 25 h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28 } 29 30 h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34 } 35 36 pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39 } 40 41 pre { 42 margin-top: 0.5em; 43 } 44 45 h1, h2, h3, p { 46 font-family: Arial, sans serif; 47 } 48 49 h1, 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> . <a href="mirror_v1.timeline.attachments.html">attachments</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="#delete">delete(itemId, attachmentId)</a></code></p> 79 <p class="firstline">Deletes an attachment from a timeline item.</p> 80 <p class="toc_element"> 81 <code><a href="#get">get(itemId, attachmentId)</a></code></p> 82 <p class="firstline">Retrieves an attachment on a timeline item by item ID and attachment ID.</p> 83 <p class="toc_element"> 84 <code><a href="#get_media">get_media(itemId, attachmentId)</a></code></p> 85 <p class="firstline">Retrieves an attachment on a timeline item by item ID and attachment ID.</p> 86 <p class="toc_element"> 87 <code><a href="#insert">insert(itemId, media_body=None, media_mime_type=None)</a></code></p> 88 <p class="firstline">Adds a new attachment to a timeline item.</p> 89 <p class="toc_element"> 90 <code><a href="#list">list(itemId)</a></code></p> 91 <p class="firstline">Returns a list of attachments for a timeline item.</p> 92 <h3>Method Details</h3> 93 <div class="method"> 94 <code class="details" id="delete">delete(itemId, attachmentId)</code> 95 <pre>Deletes an attachment from a timeline item. 96 97 Args: 98 itemId: string, The ID of the timeline item the attachment belongs to. (required) 99 attachmentId: string, The ID of the attachment. (required) 100 </pre> 101 </div> 102 103 <div class="method"> 104 <code class="details" id="get">get(itemId, attachmentId)</code> 105 <pre>Retrieves an attachment on a timeline item by item ID and attachment ID. 106 107 Args: 108 itemId: string, The ID of the timeline item the attachment belongs to. (required) 109 attachmentId: string, The ID of the attachment. (required) 110 111 Returns: 112 An object of the form: 113 114 { # Represents media content, such as a photo, that can be attached to a timeline item. 115 "contentUrl": "A String", # The URL for the content. 116 "contentType": "A String", # The MIME type of the attachment. 117 "id": "A String", # The ID of the attachment. 118 "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. 119 }</pre> 120 </div> 121 122 <div class="method"> 123 <code class="details" id="get_media">get_media(itemId, attachmentId)</code> 124 <pre>Retrieves an attachment on a timeline item by item ID and attachment ID. 125 126 Args: 127 itemId: string, The ID of the timeline item the attachment belongs to. (required) 128 attachmentId: string, The ID of the attachment. (required) 129 130 Returns: 131 The media object as a string. 132 133 </pre> 134 </div> 135 136 <div class="method"> 137 <code class="details" id="insert">insert(itemId, media_body=None, media_mime_type=None)</code> 138 <pre>Adds a new attachment to a timeline item. 139 140 Args: 141 itemId: string, The ID of the timeline item the attachment belongs to. (required) 142 media_body: string, The filename of the media request body, or an instance of a MediaUpload object. 143 media_mime_type: string, The MIME type of the media request body, or an instance of a MediaUpload object. 144 145 Returns: 146 An object of the form: 147 148 { # Represents media content, such as a photo, that can be attached to a timeline item. 149 "contentUrl": "A String", # The URL for the content. 150 "contentType": "A String", # The MIME type of the attachment. 151 "id": "A String", # The ID of the attachment. 152 "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. 153 }</pre> 154 </div> 155 156 <div class="method"> 157 <code class="details" id="list">list(itemId)</code> 158 <pre>Returns a list of attachments for a timeline item. 159 160 Args: 161 itemId: string, The ID of the timeline item whose attachments should be listed. (required) 162 163 Returns: 164 An object of the form: 165 166 { # A list of Attachments. This is the response from the server to GET requests on the attachments collection. 167 "items": [ # The list of attachments. 168 { # Represents media content, such as a photo, that can be attached to a timeline item. 169 "contentUrl": "A String", # The URL for the content. 170 "contentType": "A String", # The MIME type of the attachment. 171 "id": "A String", # The ID of the attachment. 172 "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. 173 }, 174 ], 175 "kind": "mirror#attachmentsList", # The type of resource. This is always mirror#attachmentsList. 176 }</pre> 177 </div> 178 179 </body></html>
