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

40
gen/appstate1/README.md
View File

@@ -11,10 +11,10 @@ Everything else about the *App State* *v1* API can be found at the
[official documentation site](https://developers.google.com/games/services/web/api/states).
# Features
Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google-appstate1/struct.AppState.html) ...
Handle the following *Resources* with ease from the central [hub](http://byron.github.io/google-apis-rs/google_appstate1/struct.AppState.html) ...
* states
* [*clear*](http://byron.github.io/google-apis-rs/google-appstate1/struct.StateClearCall.html), [*delete*](http://byron.github.io/google-apis-rs/google-appstate1/struct.StateDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google-appstate1/struct.StateGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google-appstate1/struct.StateListCall.html) and [*update*](http://byron.github.io/google-apis-rs/google-appstate1/struct.StateUpdateCall.html)
* [*clear*](http://byron.github.io/google-apis-rs/google_appstate1/struct.StateClearCall.html), [*delete*](http://byron.github.io/google-apis-rs/google_appstate1/struct.StateDeleteCall.html), [*get*](http://byron.github.io/google-apis-rs/google_appstate1/struct.StateGetCall.html), [*list*](http://byron.github.io/google-apis-rs/google_appstate1/struct.StateListCall.html) and [*update*](http://byron.github.io/google-apis-rs/google_appstate1/struct.StateUpdateCall.html)
@@ -23,17 +23,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-appstate1/struct.AppState.html)**
* **[Hub](http://byron.github.io/google-apis-rs/google_appstate1/struct.AppState.html)**
* a central object to maintain state and allow accessing all *Activities*
* creates [*Method Builders*](http://byron.github.io/google-apis-rs/google-appstate1/trait.MethodsBuilder.html) which in turn
allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google-appstate1/trait.CallBuilder.html)
* **[Resources](http://byron.github.io/google-apis-rs/google-appstate1/trait.Resource.html)**
* creates [*Method Builders*](http://byron.github.io/google-apis-rs/google_appstate1/trait.MethodsBuilder.html) which in turn
allow access to individual [*Call Builders*](http://byron.github.io/google-apis-rs/google_appstate1/trait.CallBuilder.html)
* **[Resources](http://byron.github.io/google-apis-rs/google_appstate1/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-appstate1/trait.Part.html)**
* **[Parts](http://byron.github.io/google-apis-rs/google_appstate1/trait.Part.html)**
* a collection of properties
* never directly used in *Activities*
* **[Activities](http://byron.github.io/google-apis-rs/google-appstate1/trait.CallBuilder.html)**
* **[Activities](http://byron.github.io/google-apis-rs/google_appstate1/trait.CallBuilder.html)**
* operations to apply to *Resources*
All *structures* are marked with applicable traits to further categorize them and ease browsing.
@@ -120,17 +120,17 @@ match result {
```
## Handling Errors
All errors produced by the system are provided either as [Result](http://byron.github.io/google-apis-rs/google-appstate1/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_appstate1/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-appstate1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google-appstate1/../yup-oauth2/trait.AuthenticatorDelegate.html).
[Hub Delegate](http://byron.github.io/google-apis-rs/google_appstate1/trait.Delegate.html), or the [Authenticator Delegate](http://byron.github.io/google-apis-rs/google_appstate1/../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-appstate1/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_appstate1/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-appstate1/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_appstate1/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")`.
@@ -140,29 +140,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-appstate1/trait.Delegate.html) to the
[Method Builder](http://byron.github.io/google-apis-rs/google-appstate1/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_appstate1/trait.Delegate.html) to the
[Method Builder](http://byron.github.io/google-apis-rs/google_appstate1/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-appstate1/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_appstate1/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-appstate1/trait.RequestValue.html) and
[decodable](http://byron.github.io/google-apis-rs/google-appstate1/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_appstate1/trait.RequestValue.html) and
[decodable](http://byron.github.io/google-apis-rs/google_appstate1/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-appstate1/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_appstate1/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-appstate1/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_appstate1/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-appstate1/trait.RequestValue.html) are borrowed
* [request values](http://byron.github.io/google-apis-rs/google_appstate1/trait.RequestValue.html) are borrowed
Arguments will always be copied or cloned into the builder, to make them independent of their original life times.