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.aliases.html">aliases</a></h1>
     76 <h2>Instance Methods</h2>
     77 <p class="toc_element">
     78   <code><a href="#delete">delete(userKey, alias)</a></code></p>
     79 <p class="firstline">Remove a alias for the user</p>
     80 <p class="toc_element">
     81   <code><a href="#insert">insert(userKey, body)</a></code></p>
     82 <p class="firstline">Add a alias for the user</p>
     83 <p class="toc_element">
     84   <code><a href="#list">list(userKey, event=None)</a></code></p>
     85 <p class="firstline">List all aliases for a user</p>
     86 <p class="toc_element">
     87   <code><a href="#watch">watch(userKey, body, event=None)</a></code></p>
     88 <p class="firstline">Watch for changes in user aliases list</p>
     89 <h3>Method Details</h3>
     90 <div class="method">
     91     <code class="details" id="delete">delete(userKey, alias)</code>
     92   <pre>Remove a alias for the user
     93 
     94 Args:
     95   userKey: string, Email or immutable Id of the user (required)
     96   alias: string, The alias to be removed (required)
     97 </pre>
     98 </div>
     99 
    100 <div class="method">
    101     <code class="details" id="insert">insert(userKey, body)</code>
    102   <pre>Add a alias for the user
    103 
    104 Args:
    105   userKey: string, Email or immutable Id of the user (required)
    106   body: object, The request body. (required)
    107     The object takes the form of:
    108 
    109 { # JSON template for Alias object in Directory API.
    110     "alias": "A String", # A alias email
    111     "kind": "admin#directory#alias", # Kind of resource this is.
    112     "etag": "A String", # ETag of the resource.
    113     "primaryEmail": "A String", # Group's primary email (Read-only) User's primary email (Read-only)
    114     "id": "A String", # Unique id of the group (Read-only) Unique id of the user (Read-only)
    115   }
    116 
    117 
    118 Returns:
    119   An object of the form:
    120 
    121     { # JSON template for Alias object in Directory API.
    122       "alias": "A String", # A alias email
    123       "kind": "admin#directory#alias", # Kind of resource this is.
    124       "etag": "A String", # ETag of the resource.
    125       "primaryEmail": "A String", # Group's primary email (Read-only) User's primary email (Read-only)
    126       "id": "A String", # Unique id of the group (Read-only) Unique id of the user (Read-only)
    127     }</pre>
    128 </div>
    129 
    130 <div class="method">
    131     <code class="details" id="list">list(userKey, event=None)</code>
    132   <pre>List all aliases for a user
    133 
    134 Args:
    135   userKey: string, Email or immutable Id of the user (required)
    136   event: string, Event on which subscription is intended (if subscribing)
    137     Allowed values
    138       add - Alias Created Event
    139       delete - Alias Deleted Event
    140 
    141 Returns:
    142   An object of the form:
    143 
    144     { # JSON response template to list aliases in Directory API.
    145     "kind": "admin#directory#aliases", # Kind of resource this is.
    146     "etag": "A String", # ETag of the resource.
    147     "aliases": [ # List of alias objects.
    148       "",
    149     ],
    150   }</pre>
    151 </div>
    152 
    153 <div class="method">
    154     <code class="details" id="watch">watch(userKey, body, event=None)</code>
    155   <pre>Watch for changes in user aliases list
    156 
    157 Args:
    158   userKey: string, Email or immutable Id of the user (required)
    159   body: object, The request body. (required)
    160     The object takes the form of:
    161 
    162 { # An notification channel used to watch for resource changes.
    163     "resourceUri": "A String", # A version-specific identifier for the watched resource.
    164     "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
    165     "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
    166     "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
    167     "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
    168     "params": { # Additional parameters controlling delivery channel behavior. Optional.
    169       "a_key": "A String", # Declares a new parameter by name.
    170     },
    171     "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
    172     "address": "A String", # The address where notifications are delivered for this channel.
    173     "type": "A String", # The type of delivery mechanism used for this channel.
    174     "id": "A String", # A UUID or similar unique string that identifies this channel.
    175   }
    176 
    177   event: string, Event on which subscription is intended (if subscribing)
    178     Allowed values
    179       add - Alias Created Event
    180       delete - Alias Deleted Event
    181 
    182 Returns:
    183   An object of the form:
    184 
    185     { # An notification channel used to watch for resource changes.
    186       "resourceUri": "A String", # A version-specific identifier for the watched resource.
    187       "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource. Value: the fixed string "api#channel".
    188       "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
    189       "payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
    190       "token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
    191       "params": { # Additional parameters controlling delivery channel behavior. Optional.
    192         "a_key": "A String", # Declares a new parameter by name.
    193       },
    194       "expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
    195       "address": "A String", # The address where notifications are delivered for this channel.
    196       "type": "A String", # The type of delivery mechanism used for this channel.
    197       "id": "A String", # A UUID or similar unique string that identifies this channel.
    198     }</pre>
    199 </div>
    200 
    201 </body></html>