You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-23Lines changed: 17 additions & 23 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,13 +1,12 @@
1
1
# Preview Microsoft Graph SDK for Java
2
2
*This SDK is currently in preview. Please continue to provide [feedback](https://github.com/microsoftgraph/msgraph-sdk-java/issues/new) as we iterate towards a production-supported library.*
3
3
4
-
# Get started with the Microsoft Graph SDK for Java
5
-
6
-
Integrate the [Microsoft Graph API](https://developer.microsoft.com/graph) into your Java application!
4
+
Get started with the Microsoft Graph SDK for Java by integrating the [Microsoft Graph API](https://graph.microsoft.io/en-us/getting-started) into your Java application!
7
5
8
6
## 1. Installation
7
+
9
8
### 1.1 Install via Gradle
10
-
Add the JCenter repository and a compile dependency for `microsoft-graph` to your project's `build.gradle`
9
+
Add the JCenter repository and a compile dependency for `microsoft-graph` to your project's `build.gradle`:
11
10
12
11
```gradle
13
12
repository {
@@ -21,27 +20,22 @@ dependency {
21
20
```
22
21
23
22
### 1.2 Enable ProGuard (Android)
24
-
25
-
The nature of the Graph API is such that the SDK needs quite a large set of classes to describe its functionality. You will need to ensure that [ProGuard](https://developer.android.com/studio/build/shrink-code.html) is enabled on your project. Otherwise, you will incur long build times for functionality that is not necessary relevant to your particular application. If you are still hitting the 64k method limit, you can also enable [multidexing](https://developer.android.com/studio/build/multidex.html).
23
+
The nature of the Graph API is such that the SDK needs quite a large set of classes to describe its functionality. You need to ensure that [ProGuard](https://developer.android.com/studio/build/shrink-code.html) is enabled on your project. Otherwise, you will incur long build times for functionality that is not necessarily relevant to your particular application. If you are still hitting the 64K method limit, you can also enable [multidexing](https://developer.android.com/studio/build/multidex.html).
26
24
27
25
## 2. Getting started
28
26
29
27
### 2.1 Register your application
30
28
31
-
Register your application by following [these](https://developer.microsoft.com/en-us/graph/docs/concepts/auth_register_app_v2) steps.
29
+
Register your application by following the steps at [Register your app with the Azure AD v2.0 endpoint](https://developer.microsoft.com/en-us/graph/docs/concepts/auth_register_app_v2).
32
30
33
31
### 2.2 Create an IAuthenticationProvider object
34
32
35
-
An instance of the **GraphServiceClient** class handles building requests,
36
-
sending them to the Microsoft Graph API, and processing the responses. To create a
37
-
new instance of this class, you need to provide an instance of
38
-
`IAuthenticationProvider` which can authenticate requests to Microsoft Graph.
33
+
An instance of the **GraphServiceClient** class handles building requests, sending them to the Microsoft Graph API, and processing the responses. To create a new instance of this class, you need to provide an instance of `IAuthenticationProvider`, which can authenticate requests to Microsoft Graph.
39
34
40
-
For an example of authentication in a client application see the [MSGraph SDK Android MSA Auth for Android Adapter](https://github.com/microsoftgraph/msgraph-sdk-android-msa-auth-for-android-adapter).
35
+
For an example of authentication in a client application, see the [MSGraph SDK Android MSA Auth for Android Adapter](https://github.com/microsoftgraph/msgraph-sdk-android-msa-auth-for-android-adapter).
41
36
42
37
### 2.3 Get a GraphServiceClient object
43
-
44
-
Once you have set the correct application ID and url, you must get a **GraphServiceClient** object to make requests against the service. The SDK will store the account information for you, but when a user logs on for the first time, it will invoke UI to get the user's account information.
38
+
After you have set the correct application ID and URL, you must get a **GraphServiceClient** object to make requests against the service. The SDK stores the account information for you, but when a user signs in for the first time, it invokes the UI to get the user's account information.
Once you have a GraphServiceClient that is authenticated you can begin making calls against the service. The requests against the service look like our [REST API](https://developer.microsoft.com/en-us/graph/docs/concepts/overview).
52
+
After you have a GraphServiceClient that is authenticated, you can begin making calls against the service. The requests against the service look like our [REST API](https://developer.microsoft.com/en-us/graph/docs/concepts/overview).
59
53
60
-
### Get the user's drive
54
+
### 3.1 Get the user's drive
61
55
62
56
To retrieve the user's drive:
63
57
@@ -80,14 +74,14 @@ For a general overview of how the SDK is designed, see [overview](https://github
@@ -96,7 +90,7 @@ For known issues, see [issues](https://github.com/MicrosoftGraph/msgraph-sdk-jav
96
90
97
91
## 6. Contributions
98
92
99
-
The Microsoft Graph SDK is open for contribution. Please read how to contribute to this project[here](https://github.com/microsoftgraph/msgraph-sdk-java/blob/master/CONTRIBUTING.md).
93
+
The Microsoft Graph SDK is open for contribution. To contribute to this project, see [Contributing](https://github.com/microsoftgraph/msgraph-sdk-java/blob/master/CONTRIBUTING.md).
100
94
101
95
Thanks to everyone who has already devoted time to improving the library:
102
96
@@ -109,13 +103,13 @@ Thanks to everyone who has already devoted time to improving the library:
109
103
110
104
This project follows the [all-contributors](https://github.com/kentcdodds/all-contributors) specification. Contributions of any kind are welcome!
111
105
112
-
## 7. Supported Java Versions
106
+
## 7. Supported Java versions
113
107
The Microsoft Graph SDK for Java library is supported at runtime for Java 7+ and [Android API revision 15](http://source.android.com/source/build-numbers.html) and greater.
114
108
115
109
## 8. License
116
110
117
111
Copyright (c) Microsoft Corporation. All Rights Reserved. Licensed under the [MIT license](LICENSE).
0 commit comments