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.notifications.html">notifications</a></h1>
     76 <h2>Instance Methods</h2>
     77 <p class="toc_element">
     78   <code><a href="#delete">delete(customer, notificationId)</a></code></p>
     79 <p class="firstline">Deletes a notification</p>
     80 <p class="toc_element">
     81   <code><a href="#get">get(customer, notificationId)</a></code></p>
     82 <p class="firstline">Retrieves a notification.</p>
     83 <p class="toc_element">
     84   <code><a href="#list">list(customer, language=None, pageToken=None, maxResults=None)</a></code></p>
     85 <p class="firstline">Retrieves a list of notifications.</p>
     86 <p class="toc_element">
     87   <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
     88 <p class="firstline">Retrieves the next page of results.</p>
     89 <p class="toc_element">
     90   <code><a href="#patch">patch(customer, notificationId, body)</a></code></p>
     91 <p class="firstline">Updates a notification. This method supports patch semantics.</p>
     92 <p class="toc_element">
     93   <code><a href="#update">update(customer, notificationId, body)</a></code></p>
     94 <p class="firstline">Updates a notification.</p>
     95 <h3>Method Details</h3>
     96 <div class="method">
     97     <code class="details" id="delete">delete(customer, notificationId)</code>
     98   <pre>Deletes a notification
     99 
    100 Args:
    101   customer: string, The unique ID for the customer's G Suite account. The customerId is also returned as part of the Users resource. (required)
    102   notificationId: string, The unique ID of the notification. (required)
    103 </pre>
    104 </div>
    105 
    106 <div class="method">
    107     <code class="details" id="get">get(customer, notificationId)</code>
    108   <pre>Retrieves a notification.
    109 
    110 Args:
    111   customer: string, The unique ID for the customer's G Suite account. The customerId is also returned as part of the Users resource. (required)
    112   notificationId: string, The unique ID of the notification. (required)
    113 
    114 Returns:
    115   An object of the form:
    116 
    117     { # Template for a notification resource.
    118       "body": "A String", # Body of the notification (Read-only)
    119       "kind": "admin#directory#notification", # The type of the resource.
    120       "etag": "A String", # ETag of the resource.
    121       "sendTime": "A String", # Time at which notification was sent (Read-only)
    122       "notificationId": "A String",
    123       "fromAddress": "A String", # Address from which the notification is received (Read-only)
    124       "isUnread": True or False, # Boolean indicating whether the notification is unread or not.
    125       "subject": "A String", # Subject of the notification (Read-only)
    126     }</pre>
    127 </div>
    128 
    129 <div class="method">
    130     <code class="details" id="list">list(customer, language=None, pageToken=None, maxResults=None)</code>
    131   <pre>Retrieves a list of notifications.
    132 
    133 Args:
    134   customer: string, The unique ID for the customer's G Suite account. (required)
    135   language: string, The ISO 639-1 code of the language notifications are returned in. The default is English (en).
    136   pageToken: string, The token to specify the page of results to retrieve.
    137   maxResults: integer, Maximum number of notifications to return per page. The default is 100.
    138 
    139 Returns:
    140   An object of the form:
    141 
    142     { # Template for notifications list response.
    143     "nextPageToken": "A String", # Token for fetching the next page of notifications.
    144     "items": [ # List of notifications in this page.
    145       { # Template for a notification resource.
    146           "body": "A String", # Body of the notification (Read-only)
    147           "kind": "admin#directory#notification", # The type of the resource.
    148           "etag": "A String", # ETag of the resource.
    149           "sendTime": "A String", # Time at which notification was sent (Read-only)
    150           "notificationId": "A String",
    151           "fromAddress": "A String", # Address from which the notification is received (Read-only)
    152           "isUnread": True or False, # Boolean indicating whether the notification is unread or not.
    153           "subject": "A String", # Subject of the notification (Read-only)
    154         },
    155     ],
    156     "kind": "admin#directory#notifications", # The type of the resource.
    157     "etag": "A String", # ETag of the resource.
    158     "unreadNotificationsCount": 42, # Number of unread notification for the domain.
    159   }</pre>
    160 </div>
    161 
    162 <div class="method">
    163     <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
    164   <pre>Retrieves the next page of results.
    165 
    166 Args:
    167   previous_request: The request for the previous page. (required)
    168   previous_response: The response from the request for the previous page. (required)
    169 
    170 Returns:
    171   A request object that you can call 'execute()' on to request the next
    172   page. Returns None if there are no more items in the collection.
    173     </pre>
    174 </div>
    175 
    176 <div class="method">
    177     <code class="details" id="patch">patch(customer, notificationId, body)</code>
    178   <pre>Updates a notification. This method supports patch semantics.
    179 
    180 Args:
    181   customer: string, The unique ID for the customer's G Suite account. (required)
    182   notificationId: string, The unique ID of the notification. (required)
    183   body: object, The request body. (required)
    184     The object takes the form of:
    185 
    186 { # Template for a notification resource.
    187     "body": "A String", # Body of the notification (Read-only)
    188     "kind": "admin#directory#notification", # The type of the resource.
    189     "etag": "A String", # ETag of the resource.
    190     "sendTime": "A String", # Time at which notification was sent (Read-only)
    191     "notificationId": "A String",
    192     "fromAddress": "A String", # Address from which the notification is received (Read-only)
    193     "isUnread": True or False, # Boolean indicating whether the notification is unread or not.
    194     "subject": "A String", # Subject of the notification (Read-only)
    195   }
    196 
    197 
    198 Returns:
    199   An object of the form:
    200 
    201     { # Template for a notification resource.
    202       "body": "A String", # Body of the notification (Read-only)
    203       "kind": "admin#directory#notification", # The type of the resource.
    204       "etag": "A String", # ETag of the resource.
    205       "sendTime": "A String", # Time at which notification was sent (Read-only)
    206       "notificationId": "A String",
    207       "fromAddress": "A String", # Address from which the notification is received (Read-only)
    208       "isUnread": True or False, # Boolean indicating whether the notification is unread or not.
    209       "subject": "A String", # Subject of the notification (Read-only)
    210     }</pre>
    211 </div>
    212 
    213 <div class="method">
    214     <code class="details" id="update">update(customer, notificationId, body)</code>
    215   <pre>Updates a notification.
    216 
    217 Args:
    218   customer: string, The unique ID for the customer's G Suite account. (required)
    219   notificationId: string, The unique ID of the notification. (required)
    220   body: object, The request body. (required)
    221     The object takes the form of:
    222 
    223 { # Template for a notification resource.
    224     "body": "A String", # Body of the notification (Read-only)
    225     "kind": "admin#directory#notification", # The type of the resource.
    226     "etag": "A String", # ETag of the resource.
    227     "sendTime": "A String", # Time at which notification was sent (Read-only)
    228     "notificationId": "A String",
    229     "fromAddress": "A String", # Address from which the notification is received (Read-only)
    230     "isUnread": True or False, # Boolean indicating whether the notification is unread or not.
    231     "subject": "A String", # Subject of the notification (Read-only)
    232   }
    233 
    234 
    235 Returns:
    236   An object of the form:
    237 
    238     { # Template for a notification resource.
    239       "body": "A String", # Body of the notification (Read-only)
    240       "kind": "admin#directory#notification", # The type of the resource.
    241       "etag": "A String", # ETag of the resource.
    242       "sendTime": "A String", # Time at which notification was sent (Read-only)
    243       "notificationId": "A String",
    244       "fromAddress": "A String", # Address from which the notification is received (Read-only)
    245       "isUnread": True or False, # Boolean indicating whether the notification is unread or not.
    246       "subject": "A String", # Subject of the notification (Read-only)
    247     }</pre>
    248 </div>
    249 
    250 </body></html>