-
Notifications
You must be signed in to change notification settings - Fork 16
/
msgraphclient.yml
49 lines (43 loc) · 2.23 KB
/
msgraphclient.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
### YamlMime:TSType
name: MSGraphClient
uid: '@microsoft/sp-http-msgraph!MSGraphClient:class'
package: '@microsoft/sp-http-msgraph!'
fullName: MSGraphClient
summary: MSGraphClient is used to perform REST calls against Microsoft Graph.
remarks: >-
The Microsoft Graph JavaScript client library is a lightweight wrapper around the Microsoft Graph API. This class
allows developers to start making REST calls to MSGraph without needing to initialize the the MSGraph client library.
If a custom configuration is desired, the MSGraphClient api function needs to be provided with that custom
configuration for every request.
For more information:
[https://github.com/microsoftgraph/msgraph-sdk-javascript](https://github.com/microsoftgraph/msgraph-sdk-javascript)
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or
create subclasses that extend the `MSGraphClient` class.
isPreview: false
isDeprecated: false
type: class
methods:
- name: 'api(path, config)'
uid: '@microsoft/sp-http-msgraph!MSGraphClient#api:member(1)'
package: '@microsoft/sp-http-msgraph!'
fullName: 'api(path, config)'
summary: All calls to Microsoft Graph are chained together starting with the api function.
remarks: >-
Path supports the following formats: \* me \* /me \* https://graph.microsoft.com/v1.0/me \*
https://graph.microsoft.com/beta/me \* me/events?$filter=startswith(subject, 'ship')
The authProvider and baseUrl option should not be used, as they have already been provided by the framework. See
the official documentation here: https://github.com/microsoftgraph/msgraph-sdk-javascript
isPreview: false
isDeprecated: false
syntax:
content: 'api(path: string, config?: Options): IGraphRequest;'
parameters:
- id: path
description: The path for the request to MSGraph.
type: string
- id: config
description: Sets the configuration for this request.
type: '<xref uid="@microsoft/microsoft-graph-client!Options:interface" />'
return:
type: '<xref uid="@microsoft/sp-http-msgraph!GraphRequest:interface" />'
description: ''