OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-02-23 15:49:49 +01:00
Code Issues Packages Projects Releases Wiki Activity

fix(README): corrected absolute links

Browse Source 
This only affected links in readme files, not the relative ones
in the actual documentation
This commit is contained in:
Sebastian Thiel
2015-04-08 17:19:04 +02:00
parent a399488c27
commit 34d0a7aad3
79 changed files with 2201 additions and 2200 deletions
Download Patch File Download Diff File Expand all files Collapse all files

76
gen/androidenterprise1/README.md
View File

@@ -8,30 +8,30 @@ The `google-androidenterprise1` library allows access to all features of the *Go
This documentation was generated from *Android Enterprise* crate version *0.1.5+20150309*, where *20150309* is the exact revision of the *androidenterprise:v1* schema built by the [mako](http://www.makotemplates.org/) code generator *v0.1.5*.
# Features
Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.AndroidEnterprise.html) ...
Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.AndroidEnterprise.html) ...
* [collections](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.Collection.html)
* [*delete*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.CollectionDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.CollectionGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.CollectionInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.CollectionListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.CollectionPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.CollectionUpdateCall.html)
* [collections](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.Collection.html)
* [*delete*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.CollectionDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.CollectionGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.CollectionInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.CollectionListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.CollectionPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.CollectionUpdateCall.html)
* collectionviewers
* [*delete*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.CollectionviewerDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.CollectionviewerGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.CollectionviewerListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.CollectionviewerPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.CollectionviewerUpdateCall.html)
* [devices](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.Device.html)
* [*get*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.DeviceGetCall.html), [*get state*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.DeviceGetStateCall.html), [*list*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.DeviceListCall.html) and [*set state*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.DeviceSetStateCall.html)
* [enterprises](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.Enterprise.html)
* [*delete*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.EnterpriseDeleteCall.html), [*enroll*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.EnterpriseEnrollCall.html), [*get*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.EnterpriseGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.EnterpriseInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.EnterpriseListCall.html), [*set account*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.EnterpriseSetAccountCall.html) and [*unenroll*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.EnterpriseUnenrollCall.html)
* [entitlements](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.Entitlement.html)
* [*delete*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.EntitlementDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.EntitlementGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.EntitlementListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.EntitlementPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.EntitlementUpdateCall.html)
* [*delete*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.CollectionviewerDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.CollectionviewerGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.CollectionviewerListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.CollectionviewerPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.CollectionviewerUpdateCall.html)
* [devices](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.Device.html)
* [*get*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.DeviceGetCall.html), [*get state*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.DeviceGetStateCall.html), [*list*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.DeviceListCall.html) and [*set state*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.DeviceSetStateCall.html)
* [enterprises](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.Enterprise.html)
* [*delete*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.EnterpriseDeleteCall.html), [*enroll*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.EnterpriseEnrollCall.html), [*get*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.EnterpriseGetCall.html), [*insert*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.EnterpriseInsertCall.html), [*list*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.EnterpriseListCall.html), [*set account*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.EnterpriseSetAccountCall.html) and [*unenroll*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.EnterpriseUnenrollCall.html)
* [entitlements](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.Entitlement.html)
* [*delete*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.EntitlementDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.EntitlementGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.EntitlementListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.EntitlementPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.EntitlementUpdateCall.html)
* grouplicenses
* [*get*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.GrouplicenseGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.GrouplicenseListCall.html)
* [*get*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.GrouplicenseGetCall.html) and [*list*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.GrouplicenseListCall.html)
* grouplicenseusers
* [*list*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.GrouplicenseuserListCall.html)
* [installs](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.Install.html)
* [*delete*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.InstallDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.InstallGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.InstallListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.InstallPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.InstallUpdateCall.html)
* [permissions](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.Permission.html)
* [*get*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.PermissionGetCall.html)
* [products](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.Product.html)
* [*get*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.ProductGetCall.html), [*get app restrictions schema*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.ProductGetAppRestrictionsSchemaCall.html), [*get permissions*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.ProductGetPermissionCall.html) and [*update permissions*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.ProductUpdatePermissionCall.html)
* [users](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.User.html)
* [*generate token*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.UserGenerateTokenCall.html), [*get*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.UserGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.UserListCall.html) and [*revoke token*](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.UserRevokeTokenCall.html)
* [*list*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.GrouplicenseuserListCall.html)
* [installs](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.Install.html)
* [*delete*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.InstallDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.InstallGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.InstallListCall.html), [*patch*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.InstallPatchCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.InstallUpdateCall.html)
* [permissions](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.Permission.html)
* [*get*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.PermissionGetCall.html)
* [products](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.Product.html)
* [*get*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.ProductGetCall.html), [*get app restrictions schema*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.ProductGetAppRestrictionsSchemaCall.html), [*get permissions*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.ProductGetPermissionCall.html) and [*update permissions*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.ProductUpdatePermissionCall.html)
* [users](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.User.html)
* [*generate token*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.UserGenerateTokenCall.html), [*get*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.UserGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.UserListCall.html) and [*revoke token*](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.UserRevokeTokenCall.html)
@@ -40,17 +40,17 @@ Handle the following *Resources* with ease from the central [hub](http://byron.g
The API is structured into the following primary items:
* **[Hub](http://byron.github.io/google-apis-rs/google-androidenterprise1/struct.AndroidEnterprise.html)**
* **[Hub](http://byron.github.io/google-apis-rs/google_androidenterprise1/struct.AndroidEnterprise.html)**
* a central object to maintain state and allow accessing all *Activities*
* creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-androidenterprise1/trait.MethodsBuilder.html) which in turn
allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-androidenterprise1/trait.CallBuilder.html)
* **[Resources](http://byron.github.io/google-apis-rs/google-androidenterprise1/trait.Resource.html)**
* creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_androidenterprise1/trait.MethodsBuilder.html) which in turn
allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_androidenterprise1/trait.CallBuilder.html)
* **[Resources](http://byron.github.io/google-apis-rs/google_androidenterprise1/trait.Resource.html)**
* primary types that you can apply *Activities* to
* a collection of properties and *Parts*
* **[Parts](http://byron.github.io/google-apis-rs/google-androidenterprise1/trait.Part.html)**
* **[Parts](http://byron.github.io/google-apis-rs/google_androidenterprise1/trait.Part.html)**
* a collection of properties
* never directly used in *Activities*
* **[Activities](http://byron.github.io/google-apis-rs/google-androidenterprise1/trait.CallBuilder.html)**
* **[Activities](http://byron.github.io/google-apis-rs/google_androidenterprise1/trait.CallBuilder.html)**
* operations to apply to *Resources*
All *structures* are marked with applicable traits to further categorize them and ease browsing.
@@ -141,17 +141,17 @@ match result {
```
## Handling Errors
All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-androidenterprise1/enum.Result.html) enumeration as return value of
All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google_androidenterprise1/enum.Result.html) enumeration as return value of
the doit() methods, or handed as possibly intermediate results to either the
[Hub Delegate](http://byron.github.io/google-apis-rs/google-androidenterprise1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-androidenterprise1/../yup-oauth2/trait.AuthenticatorDelegate.html).
[Hub Delegate](http://byron.github.io/google-apis-rs/google_androidenterprise1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_androidenterprise1/../yup-oauth2/trait.AuthenticatorDelegate.html).
When delegates handle errors or intermediate values, they may have a chance to instruct the system to retry. This
makes the system potentially resilient to all kinds of errors.
## Uploads and Downloads
If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google-androidenterprise1/enum.Result.html), should be
If a method supports downloads, the response body, which is part of the [Result](http://byron.github.io/google-apis-rs/google_androidenterprise1/enum.Result.html), should be
read by you to obtain the media.
If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google-androidenterprise1/trait.ResponseResult.html), it will return that by default.
If such a method also supports a [Response Result](http://byron.github.io/google-apis-rs/google_androidenterprise1/trait.ResponseResult.html), it will return that by default.
You can see it as meta-data for the actual media. To trigger a media download, you will have to set up the builder by making
this call: `.param("alt", "media")`.
@@ -161,29 +161,29 @@ Methods supporting uploads can do so using up to 2 different protocols:
## Customization and Callbacks
You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google-androidenterprise1/trait.Delegate.html) to the
[Method Builder](http://byron.github.io/google-apis-rs/google-androidenterprise1/trait.CallBuilder.html) before making the final `doit()` call.
You may alter the way an `doit()` method is called by providing a [delegate](http://byron.github.io/google-apis-rs/google_androidenterprise1/trait.Delegate.html) to the
[Method Builder](http://byron.github.io/google-apis-rs/google_androidenterprise1/trait.CallBuilder.html) before making the final `doit()` call.
Respective methods will be called to provide progress information, as well as determine whether the system should
retry on failure.
The [delegate trait](http://byron.github.io/google-apis-rs/google-androidenterprise1/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort.
The [delegate trait](http://byron.github.io/google-apis-rs/google_androidenterprise1/trait.Delegate.html) is default-implemented, allowing you to customize it with minimal effort.
## Optional Parts in Server-Requests
All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google-androidenterprise1/trait.RequestValue.html) and
[decodable](http://byron.github.io/google-apis-rs/google-androidenterprise1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses
All structures provided by this library are made to be [enocodable](http://byron.github.io/google-apis-rs/google_androidenterprise1/trait.RequestValue.html) and
[decodable](http://byron.github.io/google-apis-rs/google_androidenterprise1/trait.ResponseResult.html) via *json*. Optionals are used to indicate that partial requests are responses
are valid.
Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google-androidenterprise1/trait.Part.html) which are identifiable by name, which will be sent to
Most optionals are are considered [Parts](http://byron.github.io/google-apis-rs/google_androidenterprise1/trait.Part.html) which are identifiable by name, which will be sent to
the server to indicate either the set parts of the request or the desired parts in the response.
## Builder Arguments
Using [method builders](http://byron.github.io/google-apis-rs/google-androidenterprise1/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods.
Using [method builders](http://byron.github.io/google-apis-rs/google_androidenterprise1/trait.CallBuilder.html), you are able to prepare an action call by repeatedly calling it's methods.
These will always take a single argument, for which the following statements are true.
* [PODs][wiki-pod] are handed by copy
* strings are passed as `&str`
* [request values](http://byron.github.io/google-apis-rs/google-androidenterprise1/trait.RequestValue.html) are borrowed
* [request values](http://byron.github.io/google-apis-rs/google_androidenterprise1/trait.RequestValue.html) are borrowed
Arguments will always be copied or cloned into the builder, to make them independent of their original life times.