Home | History | Annotate | Download | only in dyn
      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="admin_directory_v1.html">Admin Directory API</a> . <a href="admin_directory_v1.users.html">users</a> . <a href="admin_directory_v1.users.photos.html">photos</a></h1>
     76 <h2>Instance Methods</h2>
     77 <p class="toc_element">
     78   <code><a href="#delete">delete(userKey)</a></code></p>
     79 <p class="firstline">Remove photos for the user</p>
     80 <p class="toc_element">
     81   <code><a href="#get">get(userKey)</a></code></p>
     82 <p class="firstline">Retrieve photo of a user</p>
     83 <p class="toc_element">
     84   <code><a href="#patch">patch(userKey, body)</a></code></p>
     85 <p class="firstline">Add a photo for the user. This method supports patch semantics.</p>
     86 <p class="toc_element">
     87   <code><a href="#update">update(userKey, body)</a></code></p>
     88 <p class="firstline">Add a photo for the user</p>
     89 <h3>Method Details</h3>
     90 <div class="method">
     91     <code class="details" id="delete">delete(userKey)</code>
     92   <pre>Remove photos for the user
     93 
     94 Args:
     95   userKey: string, Email or immutable Id of the user (required)
     96 </pre>
     97 </div>
     98 
     99 <div class="method">
    100     <code class="details" id="get">get(userKey)</code>
    101   <pre>Retrieve photo of a user
    102 
    103 Args:
    104   userKey: string, Email or immutable Id of the user (required)
    105 
    106 Returns:
    107   An object of the form:
    108 
    109     { # JSON template for Photo object in Directory API.
    110       "mimeType": "A String", # Mime Type of the photo
    111       "kind": "admin#directory#user#photo", # Kind of resource this is.
    112       "photoData": "A String", # Base64 encoded photo data
    113       "height": 42, # Height in pixels of the photo
    114       "width": 42, # Width in pixels of the photo
    115       "etag": "A String", # ETag of the resource.
    116       "primaryEmail": "A String", # Primary email of User (Read-only)
    117       "id": "A String", # Unique identifier of User (Read-only)
    118     }</pre>
    119 </div>
    120 
    121 <div class="method">
    122     <code class="details" id="patch">patch(userKey, body)</code>
    123   <pre>Add a photo for the user. This method supports patch semantics.
    124 
    125 Args:
    126   userKey: string, Email or immutable Id of the user (required)
    127   body: object, The request body. (required)
    128     The object takes the form of:
    129 
    130 { # JSON template for Photo object in Directory API.
    131     "mimeType": "A String", # Mime Type of the photo
    132     "kind": "admin#directory#user#photo", # Kind of resource this is.
    133     "photoData": "A String", # Base64 encoded photo data
    134     "height": 42, # Height in pixels of the photo
    135     "width": 42, # Width in pixels of the photo
    136     "etag": "A String", # ETag of the resource.
    137     "primaryEmail": "A String", # Primary email of User (Read-only)
    138     "id": "A String", # Unique identifier of User (Read-only)
    139   }
    140 
    141 
    142 Returns:
    143   An object of the form:
    144 
    145     { # JSON template for Photo object in Directory API.
    146       "mimeType": "A String", # Mime Type of the photo
    147       "kind": "admin#directory#user#photo", # Kind of resource this is.
    148       "photoData": "A String", # Base64 encoded photo data
    149       "height": 42, # Height in pixels of the photo
    150       "width": 42, # Width in pixels of the photo
    151       "etag": "A String", # ETag of the resource.
    152       "primaryEmail": "A String", # Primary email of User (Read-only)
    153       "id": "A String", # Unique identifier of User (Read-only)
    154     }</pre>
    155 </div>
    156 
    157 <div class="method">
    158     <code class="details" id="update">update(userKey, body)</code>
    159   <pre>Add a photo for the user
    160 
    161 Args:
    162   userKey: string, Email or immutable Id of the user (required)
    163   body: object, The request body. (required)
    164     The object takes the form of:
    165 
    166 { # JSON template for Photo object in Directory API.
    167     "mimeType": "A String", # Mime Type of the photo
    168     "kind": "admin#directory#user#photo", # Kind of resource this is.
    169     "photoData": "A String", # Base64 encoded photo data
    170     "height": 42, # Height in pixels of the photo
    171     "width": 42, # Width in pixels of the photo
    172     "etag": "A String", # ETag of the resource.
    173     "primaryEmail": "A String", # Primary email of User (Read-only)
    174     "id": "A String", # Unique identifier of User (Read-only)
    175   }
    176 
    177 
    178 Returns:
    179   An object of the form:
    180 
    181     { # JSON template for Photo object in Directory API.
    182       "mimeType": "A String", # Mime Type of the photo
    183       "kind": "admin#directory#user#photo", # Kind of resource this is.
    184       "photoData": "A String", # Base64 encoded photo data
    185       "height": 42, # Height in pixels of the photo
    186       "width": 42, # Width in pixels of the photo
    187       "etag": "A String", # ETag of the resource.
    188       "primaryEmail": "A String", # Primary email of User (Read-only)
    189       "id": "A String", # Unique identifier of User (Read-only)
    190     }</pre>
    191 </div>
    192 
    193 </body></html>