OLD | NEW |
1 // Copyright (c) 2012, the Dart project authors. Please see the AUTHORS file | 1 // Copyright (c) 2012, the Dart project authors. Please see the AUTHORS file |
2 // for details. All rights reserved. Use of this source code is governed by a | 2 // for details. All rights reserved. Use of this source code is governed by a |
3 // BSD-style license that can be found in the LICENSE file. | 3 // BSD-style license that can be found in the LICENSE file. |
4 | 4 |
5 /// A client library for authenticating with a remote service via OAuth2 on | 5 /// A client library for authenticating with a remote service via OAuth2 on |
6 /// behalf of a user, and making authorized HTTP requests with the user's OAuth2 | 6 /// behalf of a user, and making authorized HTTP requests with the user's OAuth2 |
7 /// credentials. | 7 /// credentials. |
8 /// | 8 /// |
9 /// ## Installing ## | 9 /// ## Installing ## |
10 /// | 10 /// |
(...skipping 16 matching lines...) Expand all Loading... |
27 /// to give the client an access token. This token serves as proof that the | 27 /// to give the client an access token. This token serves as proof that the |
28 /// client has permission to access resources on behalf of the resource owner. | 28 /// client has permission to access resources on behalf of the resource owner. |
29 /// | 29 /// |
30 /// OAuth2 provides several different methods for the client to obtain | 30 /// OAuth2 provides several different methods for the client to obtain |
31 /// authorization. At the time of writing, this library only supports the | 31 /// authorization. At the time of writing, this library only supports the |
32 /// [AuthorizationCodeGrant] method, but further methods may be added in the | 32 /// [AuthorizationCodeGrant] method, but further methods may be added in the |
33 /// future. The following example uses this method to authenticate, and assumes | 33 /// future. The following example uses this method to authenticate, and assumes |
34 /// that the library is being used by a server-side application. | 34 /// that the library is being used by a server-side application. |
35 /// | 35 /// |
36 /// import 'dart:io' | 36 /// import 'dart:io' |
37 /// import 'dart:uri' | |
38 /// import 'package:oauth2/oauth2.dart' as oauth2; | 37 /// import 'package:oauth2/oauth2.dart' as oauth2; |
39 /// | 38 /// |
40 /// // These URLs are endpoints that are provided by the authorization | 39 /// // These URLs are endpoints that are provided by the authorization |
41 /// // server. They're usually included in the server's documentation of its | 40 /// // server. They're usually included in the server's documentation of its |
42 /// // OAuth2 API. | 41 /// // OAuth2 API. |
43 /// final authorizationEndpoint = | 42 /// final authorizationEndpoint = |
44 /// Uri.parse("http://example.com/oauth2/authorization"); | 43 /// Uri.parse("http://example.com/oauth2/authorization"); |
45 /// final tokenEndpoint = | 44 /// final tokenEndpoint = |
46 /// Uri.parse("http://example.com/oauth2/token"); | 45 /// Uri.parse("http://example.com/oauth2/token"); |
47 /// | 46 /// |
(...skipping 68 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
116 /// | 115 /// |
117 /// [pub]: http://pub.dartlang.org | 116 /// [pub]: http://pub.dartlang.org |
118 /// [pkg]: http://pub.dartlang.org/packages/oauth2 | 117 /// [pkg]: http://pub.dartlang.org/packages/oauth2 |
119 library oauth2; | 118 library oauth2; |
120 | 119 |
121 export 'src/authorization_code_grant.dart'; | 120 export 'src/authorization_code_grant.dart'; |
122 export 'src/client.dart'; | 121 export 'src/client.dart'; |
123 export 'src/credentials.dart'; | 122 export 'src/credentials.dart'; |
124 export 'src/authorization_exception.dart'; | 123 export 'src/authorization_exception.dart'; |
125 export 'src/expiration_exception.dart'; | 124 export 'src/expiration_exception.dart'; |
OLD | NEW |