Skip to content

Commit 6de6cff

Browse files
committed
Initial commit
0 parents  commit 6de6cff

8 files changed

+1112
-0
lines changed

.gitignore

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
*.log
2+
npm-debug.log*
3+
node_modules
4+
npm-debug.log
5+
6+
7+
# Bundled npm package
8+
*.tgz
9+
10+
# Only keep microsoft-graph-tests.ts in the repo
11+
microsoft-graph-tests.js

CONTRIBUTING.md

+216
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,216 @@
1+
Contribute to this documentation
2+
3+
Thank you for your interest in our documentation!
4+
5+
* [Ways to contribute](#ways-to-contribute)
6+
* [Contribute using GitHub](#contribute-using-github)
7+
* [Contribute using Git](#contribute-using-git)
8+
* [How to use Markdown to format your topic](#how-to-use-markdown-to-format-your-topic)
9+
* [FAQ](#faq)
10+
* [More resources](#more-resources)
11+
12+
## Ways to contribute
13+
14+
Here are some ways you can contribute to this documentation:
15+
16+
* To make small changes to an article, [Contribute using GitHub](#contribute-using-github).
17+
* To make large changes, or changes that involve code, [Contribute using Git](#contribute-using-git).
18+
* Report documentation bugs via GitHub Issues
19+
* Request new documentation at the [Office Developer Platform UserVoice](http://officespdev.uservoice.com) site.
20+
21+
## Contribute using GitHub
22+
23+
Use GitHub to contribute to this documentation without having to clone the repo to your desktop. This is the easiest way to create a pull request in this repository. Use this method to make a minor change that doesn't involve code changes.
24+
25+
**Note** Using this method allows you to contribute to one article at a time.
26+
27+
### To Contribute using GitHub
28+
29+
1. Find the article you want to contribute to on GitHub.
30+
31+
If the article is in MSDN, choose the **suggest and submit changes** link in the **Contribute to this content** section and you'll be taken to the same article on GitHub.
32+
2. Once you are on the article in GitHub, sign in to GitHub (get a free account [Join GitHub](https://github.com/join).
33+
3. Choose the **pencil icon** (edit the file in your fork of this project) and make your changes in the **<>Edit file** window.
34+
4. Scroll to the bottom and enter a description.
35+
5. Choose **Propose file change**>**Create pull request**.
36+
37+
You now have successfully submitted a pull request. Pull requests are typically reviewed within 10 business days.
38+
39+
40+
## Contribute using Git
41+
42+
Use Git to contribute substantive changes, such as:
43+
44+
* Contributing code.
45+
* Contributing changes that affect meaning.
46+
* Contributing large changes to text.
47+
* Adding new topics.
48+
49+
### To Contribute using Git
50+
51+
1. If you don't have a GitHub account, set one up at [GitHub](https://github.com/join).
52+
2. After you have an account, install Git on your computer. Follow the steps in [Setting up Git Tutorial](https://help.github.com/articles/set-up-git/).
53+
3. To submit a pull request using Git, follow the steps in [Use GitHub, Git, and this repository](#use-github-git-and-this-repository).
54+
4. You will be asked to sign the Contributor's License Agreement if you are:
55+
56+
* A member of the Microsoft Open Technologies group.
57+
* A contributors who doesn't work for Microsoft.
58+
59+
As a community member, you must sign the Contribution License Agreement (CLA) before you can contribute large submissions to a project. You only need to complete and submit the documentation once. Carefully review the document. You may be required to have your employer sign the document.
60+
61+
Signing the CLA does not grant you rights to commit to the main repository, but it does mean that the Office Developer and Office Developer Content Publishing teams will be able to review and approve your contributions. You will be credited for your submissions.
62+
63+
Pull requests are typically reviewed within 10 business days.
64+
65+
## Use GitHub, Git, and this repository
66+
67+
**Note:** Most of the information in this section can be found in [GitHub Help] articles. If you're familiar with Git and GitHub, skip to the **Contribute and edit content** section for the specifics of the code/content flow of this repository.
68+
69+
### To set up your fork of the repository
70+
71+
1. Set up a GitHub account so you can contribute to this project. If you haven't done this, go to [GitHub](https://github.com/join) and do it now.
72+
2. Install Git on your computer. Follow the steps in the [Setting up Git Tutorial] [Set Up Git].
73+
3. Create your own fork of this repository. To do this, at the top of the page, choose the **Fork** button.
74+
4. Copy your fork to your computer. To do this, open Git Bash. At the command prompt enter:
75+
76+
git clone https://github.com/<your user name>/<repo name>.git
77+
78+
Next, create a reference to the root repository by entering these commands:
79+
80+
cd <repo name>
81+
git remote add upstream https://github.com/microsoftgraph/<repo name>.git
82+
git fetch upstream
83+
84+
Congratulations! You've now set up your repository. You won't need to repeat these steps again.
85+
86+
### Contribute and edit content
87+
88+
To make the contribution process as seamless as possible, follow these steps.
89+
90+
#### To contribute and edit content
91+
92+
1. Create a new branch.
93+
2. Add new content or edit existing content.
94+
3. Submit a pull request to the main repository.
95+
4. Delete the branch.
96+
97+
**Important** Limit each branch to a single concept/article to streamline the work flow and reduce the chance of merge conflicts. Content appropriate for a new branch includes:
98+
99+
* A new article.
100+
* Spelling and grammar edits.
101+
* Applying a single formatting change across a large set of articles (for example, applying a new copyright footer).
102+
103+
#### To create a new branch
104+
105+
1. Open Git Bash.
106+
2. At the Git Bash command prompt, type `git pull upstream master:<new branch name>`. This creates a new branch locally that is copied from the latest MicrosoftGraph master branch.
107+
3. At the Git Bash command prompt, type `git push origin <new branch name>`. This alerts GitHub to the new branch. You should now see the new branch in your fork of the repository on GitHub.
108+
4. At the Git Bash command prompt, type `git checkout <new branch name>` to switch to your new branch.
109+
110+
#### Add new content or edit existing content
111+
112+
You navigate to the repository on your computer by using File Explorer. The repository files are in `C:\Users\<yourusername>\<repo name>`.
113+
114+
To edit files, open them in an editor of your choice and modify them. To create a new file, use the editor of your choice and save the new file in the appropriate location in your local copy of the repository. While working, save your work frequently.
115+
116+
The files in `C:\Users\<yourusername>\<repo name>` are a working copy of the new branch that you created in your local repository. Changing anything in this folder doesn't affect the local repository until you commit a change. To commit a change to the local repository, type the following commands in GitBash:
117+
118+
git add .
119+
git commit -v -a -m "<Describe the changes made in this commit>"
120+
121+
The `add` command adds your changes to a staging area in preparation for committing them to the repository. The period after the `add` command specifies that you want to stage all of the files that you added or modified, checking subfolders recursively. (If you don't want to commit all of the changes, you can add specific files. You can also undo a commit. For help, type `git add -help` or `git status`.)
122+
123+
The `commit` command applies the staged changes to the repository. The switch `-m` means you are providing the commit comment in the command line. The -v and -a switches can be omitted. The -v switch is for verbose output from the command, and -a does what you already did with the add command.
124+
125+
You can commit multiple times while you are doing your work, or you can commit once when you're done.
126+
127+
#### Submit a pull request to the main repository
128+
129+
When you're finished with your work and are ready to have it merged into the main repository, follow these steps.
130+
131+
#### To submit a pull request to the main repository
132+
133+
1. In the Git Bash command prompt, type `git push origin <new branch name>`. In your local repository, `origin` refers to your GitHub repository that you cloned the local repository from. This command pushes the current state of your new branch, including all commits made in the previous steps, to your GitHub fork.
134+
2. On the GitHub site, navigate in your fork to the new branch.
135+
3. Choose the **Pull Request** button at the top of the page.
136+
4. Verify the Base branch is `microsoftgraph/<repo name>@master` and the Head branch is `<your username>/<repo name>@<branch name>`.
137+
5. Choose the **Update Commit Range** button.
138+
6. Add a title to your pull request, and describe all the changes you're making.
139+
7. Submit the pull request.
140+
141+
One of the site administrators will process your pull request. Your pull request will surface on the microsoftgraph/<repo name> site under Issues. When the pull request is accepted, the issue will be resolved.
142+
143+
#### Create a new branch after merge
144+
145+
After a branch is successfully merged (that is, your pull request is accepted), don't continue working in that local branch. This can lead to merge conflicts if you submit another pull request. To do another update, create a new local branch from the successfully merged upstream branch, and then delete your initial local branch.
146+
147+
For example, if your local branch X was successfully merged into the OfficeDev/microsoft-graph-docs master branch and you want to make additional updates to the content that was merged. Create a new local branch, X2, from the OfficeDev/microsoft-graph-docs master branch. To do this, open GitBash and execute the following commands:
148+
149+
cd microsoft-graph-docs
150+
git pull upstream master:X2
151+
git push origin X2
152+
153+
You now have local copies (in a new local branch) of the work that you submitted in branch X. The X2 branch also contains all the work other writers have merged, so if your work depends on others' work (for example, shared images), it is available in the new branch. You can verify that your previous work (and others' work) is in the branch by checking out the new branch...
154+
155+
git checkout X2
156+
157+
...and verifying the content. (The `checkout` command updates the files in `C:\Users\<yourusername>\microsoft-graph-docs` to the current state of the X2 branch.) Once you check out the new branch, you can make updates to the content and commit them as usual. However, to avoid working in the merged branch (X) by mistake, it's best to delete it (see the following **Delete a branch** section).
158+
159+
#### Delete a branch
160+
161+
Once your changes are successfully merged into the main repository, delete the branch you used because you no longer need it. Any additional work should be done in a new branch.
162+
163+
#### To delete a branch
164+
165+
1. In the Git Bash command prompt, type `git checkout master`. This ensures that you aren't in the branch to be deleted (which isn't allowed).
166+
2. Next, at the command prompt, type `git branch -d <branch name>`. This deletes the branch on your computer only if it has been successfully merged to the upstream repository. (You can override this behavior with the `–D` flag, but first be sure you want to do this.)
167+
3. Finally, type `git push origin :<branch name>` at the command prompt (a space before the colon and no space after it). This will delete the branch on your github fork.
168+
169+
Congratulations, you have successfully contributed to the project!
170+
171+
## How to use Markdown to format your topic
172+
173+
### Article template
174+
175+
The [markdown template](/articles/0-markdown-template-for-new-articles.md) contains the basic Markdown for a topic that includes a table of contents, sections with subheadings, links to other Office developer topics, links to other sites, bold text, italic text, numbered and bulleted lists, code snippets, and images.
176+
177+
178+
### Standard Markdown
179+
180+
All of the articles in this repository use Markdown. A complete introduction (and listing of all the syntax) can be found at [Markdown Home] [].
181+
182+
## FAQ
183+
184+
### How do I get a GitHub account?
185+
186+
Fill out the form at [Join GitHub](https://github.com/join) to open a free GitHub account.
187+
188+
### Where do I get a Contributor's License Agreement?
189+
190+
You will automatically be sent a notice that you need to sign the Contributor's License Agreement (CLA) if your pull request requires one.
191+
192+
As a community member, **you must sign the Contribution License Agreement (CLA) before you can contribute large submissions to this project**. You only need complete and submit the documentation once. Carefully review the document. You may be required to have your employer sign the document.
193+
194+
### What happens with my contributions?
195+
196+
When you submit your changes, via a pull request, our team will be notified and will review your pull request. You will receive notifications about your pull request from GitHub; you may also be notified by someone from our team if we need more information. We reserve the right to edit your submission for legal, style, clarity, or other issues.
197+
198+
### Can I become an approver for this repository's GitHub pull requests?
199+
200+
Currently, we are not allowing external contributors to approve pull requests in this repository.
201+
202+
### How soon will I get a response about my change request or issue?
203+
204+
We typically review pull requests and respond to issues within 10 business days.
205+
206+
## More resources
207+
208+
* To learn more about Markdown, go to the Git creator's site [Daring Fireball].
209+
* To learn more about using Git and GitHub, first check out the [GitHub Help section] [GitHub Help].
210+
211+
[GitHub Home]: http://github.com
212+
[GitHub Help]: http://help.github.com/
213+
[Set Up Git]: http://help.github.com/win-set-up-git/
214+
[Markdown Home]: http://daringfireball.net/projects/markdown/
215+
[Daring Fireball]: http://daringfireball.net/
216+

LICENSE

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
Microsoft Graph TypeScript Typings
2+
3+
Copyright 2015 Microsoft Corporation
4+
5+
All right reserved.
6+
7+
MIT License
8+
9+
Permission is hereby granted, free of charge, to any person obtaining a copy
10+
of this software and associated documentation files (the "Software"), to deal
11+
in the Software without restriction, including without limitation the rights
12+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13+
copies of the Software, and to permit persons to whom the Software is
14+
furnished to do so, subject to the following conditions:
15+
16+
The above copyright notice and this permission notice shall be included in
17+
all copies or substantial portions of the Software.
18+
19+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25+
THE SOFTWARE.

README.md

+91
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
# Microsoft Graph TypeScript Typings
2+
The Microsoft Graph TypeScript definitions enable editors to provide intellisense on Microsoft Graph objects.
3+
4+
You can use Microsoft Graph definitions in your project in a few ways:
5+
* Directly reference microsoft-graph.d.ts with a triple slash reference at the top of your .ts files.
6+
```/// <reference path="microsoft-graph.d.ts" />```.
7+
* Use a [tsconfig.json](http://www.typescriptlang.org/docs/handbook/tsconfig-json.html) file so the /// reference doesn't need to be in every .ts file. By default, all files (including .d.ts) will be included in the directly where tsconfig.json resides.
8+
9+
![GIF showing intellisense and autocompletion for Microsoft Graph entities in Visual Studio Code ](https://github.com/microsoftgraph/msgraph-typescript-typings/raw/master/typings-demo.gif)
10+
## Examples
11+
The following examples assume that you have a valid access token. We used [superagent](https://github.com/visionmedia/superagent) to perform the HTTP requests, but you can use [our JavaScript SDK](https://github.com/microsoftgraph/msgraph-sdk-javascript) or other libraries as well.
12+
```typescript
13+
import * as request from 'superagent';
14+
const accessToken:string = "";
15+
```
16+
### List my recent messages
17+
```typescript
18+
request
19+
.get("https://graph.microsoft.com/v1.0/me/messages")
20+
.set('Authorization', 'Bearer ' + accessToken)
21+
.end((err, res) => {
22+
if (err) {
23+
console.error(err)
24+
return;
25+
}
26+
let messages:[MicrosoftGraph.Message] = res.body.value;
27+
for (let msg of messages) { //iterate through the recent messages
28+
console.log(msg.subject);
29+
console.log(msg.toRecipients[0].emailAddress.address);
30+
}
31+
32+
})
33+
```
34+
### Send an email as the logged in user
35+
```typescript
36+
// Create the message object
37+
38+
// Note that all the properties must follow the interface definitions.
39+
// For example, this will not compile if you try to type "xml" instead of "html" for contentType.
40+
41+
let mail:MicrosoftGraph.Message = {
42+
subject: "Microsoft Graph TypeScript Sample",
43+
toRecipients: [{
44+
emailAddress: {
45+
address: "[email protected]"
46+
}
47+
}],
48+
body: {
49+
content: "<h1>Microsoft Graph TypeScript Sample</h1>Try modifying the sample",
50+
contentType: "html"
51+
}
52+
}
53+
// send the email by sending a POST request to the Microsoft Graph
54+
request
55+
.post('https://graph.microsoft.com/v1.0/users/me/sendMail')
56+
.send({message: mail})
57+
.set('Authorization', 'Bearer ' + accessToken)
58+
.end((err, res) => {
59+
if (err) {
60+
console.error(err)
61+
return;
62+
}
63+
console.log(res)
64+
})
65+
66+
```
67+
68+
## Note about date values
69+
All DateTimeOffset values are returned as strings from Microsoft Graph and should be wrapped in ```new Date()``` at runtime.
70+
```typescript
71+
let me:MicrosoftGraph.User = {}; // result from graph
72+
let myBirthday = new Date(me.birthday);
73+
console.log(myBirthday.toDateString());
74+
```
75+
76+
## Questions and comments
77+
78+
We'd love to get your feedback about the TypeScript definitions project. You can send your questions and suggestions to us in the [Issues](https://github.com/microsoftgraph/msgraph-typescript-typings/issues) section of this repository.
79+
80+
81+
## Contributing
82+
Please see the [contributing guidelines](CONTRIBUTING.md).
83+
84+
## Additional resources
85+
86+
* [Microsoft Graph](https://graph.microsoft.io)
87+
* [Office Dev Center](http://dev.office.com/)
88+
* [Microsoft Graph JavaScript SDK](https://github.com/microsoftgraph/msgraph-sdk-javascript)
89+
90+
## Copyright
91+
Copyright (c) 2016 Microsoft. All rights reserved.

0 commit comments

Comments
 (0)