TryIT.MicrosoftGraphService
1.2.3
Suggested Alternatives
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package TryIT.MicrosoftGraphService --version 1.2.3
NuGet\Install-Package TryIT.MicrosoftGraphService -Version 1.2.3
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="TryIT.MicrosoftGraphService" Version="1.2.3" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add TryIT.MicrosoftGraphService --version 1.2.3
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: TryIT.MicrosoftGraphService, 1.2.3"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install TryIT.MicrosoftGraphService as a Cake Addin #addin nuget:?package=TryIT.MicrosoftGraphService&version=1.2.3 // Install TryIT.MicrosoftGraphService as a Cake Tool #tool nuget:?package=TryIT.MicrosoftGraphService&version=1.2.3
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
How to use this library
access https://docs.microsoft.com/en-us/graph/auth-v2-user to understand more
- create a page to allow manual sign in account
- page callback method, obtain access_token and save it in somewhere (e.g. Session / DB)
- use that access_token to call Graph Service
How to use TokenHelper to obtain access_token
- add reference to
TryIT.MicrosoftGraphService
into your code - create a page to allow Administrator initial token
- in that page, use example code below to get token and save it
// page action call this method, and this method will redirect to AD login page
private MsGraphGetTokenConfig GetTokenConfig
{
get
{
return new MsGraphGetTokenConfig
{
OAuth_AuthorizeUrl = "",
OAuth_TenantId = "",
OAuth_ClientId = "",
OAuth_RedirectUrl = "", // this is Callback url
OAuth_Scope = "",
OAuth_GetTokenUrl = "",
OAuth_ClientSecret = "",
OAuth_IsProxyRequired = "",
Proxy_Url = "",
Proxy_Username = "",
Proxy_Password = ""
};
}
}
public void SignIn()
{
TokenHelper tokenHelper = new TokenHelper(GetTokenConfig);
// 1. validate token config
if (tokenHelper.IsOAuthParameterValid)
{
// if token parameter is valid, then use browser redirect to the tokenHelper.AuthorizeUrl (Callback below)
string authorizeURL = tokenHelper.AuthorizeUrl;
// use code to redirect to authorizeURL
this.RedirectUrl(authorizeURL);
}
}
// this url is configured in Azure, after sign in, will redirect back to this url
public void Callback()
{
string code = string.Empty;
string state = string.Empty;
if (!string.IsNullOrEmpty(code))
{
GetTokenResponse tokenResponse = tokenHelper.GetToken(code, state);
// save token if need
}
else
{
// invalid response
}
}
private void SaveToken(GetTokenResponse token)
{
// save token somewhere
}
private string GetToken()
{
/*
* 1. get exists token (StateGuid, ExpiresOn, Access_token, Refresh_token)
* 2. check token expiry, if ExpiresOn < Now, need refresh token to get new token
* 3. save new token
*/
var savedToken = "" // get saved token from session / db, this could be Object or DataTable
if("savedToken is valid" == true) // check the token validity, e.g. check is not null
{
GetTokenResponse token = new GetTokenResponse
{
state = "[get state from exists token]",
expires_on = "[get expires_on from exists token]",
access_token = "[get expires_on from exists token]",
refresh_token = "[get refresh_token from exists token]"
};
// here check token expiry, expires_on < DateTime.Now, if expired, will call RefreshToken to get latest valid token
if(token.expires_on < DateTime.Now)
{
MsGraphGetTokenConfig tokenConfig = GetTokenConfig;
TokenHelper tokenHelper = new TokenHelper(tokenConfig);
GetTokenResponse tokenResponse = tokenHelper.RefreshToken(token.refresh_token, token.state);
SaveToken(tokenResponse);
return tokenResponse.access_token;
}
return token.access_token;
}
else
{
throw new Exception("Token not exists, please SignIn first.");
}
}
How to use this package to access GraphAPI
- add reference to
TryIT.MicrosoftGraphService
into your code - use following example code
MsGraphApiConfig graphConfig = new MsGraphApiConfig
{
Proxy_Url = "[if the network restricted need proxy setup, indicator Proxy Url here]",
Proxy_Username = "[if the network restricted need proxy setup, indicator Proxy Username here]",
Proxy_Password = "[if the network restricted need proxy setup, indicator Proxy Password here]",
Token = GetToken(); // "[this should be valid token, service will use this token to call Graph API]"
};
MsGraphService.Outlook MsOutlook = new MsGraphService.Outlook(graphConfig);
MsOutlook.GetMessages("emailaddress", "Inbox");
Note
MsGraphService.Sharepoint
Upload file method will replace #
to _
in file name
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.NETStandard 2.0
- Newtonsoft.Json (>= 13.0.1)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated | |
---|---|---|---|
1.4.3 | 265 | 7/21/2023 | |
1.4.2 | 208 | 7/21/2023 | |
1.4.1 | 216 | 7/20/2023 | |
1.4.0 | 190 | 7/20/2023 | |
1.3.9 | 193 | 7/20/2023 | |
1.3.8 | 203 | 7/20/2023 | |
1.3.7 | 236 | 7/3/2023 | |
1.3.6 | 216 | 7/3/2023 | |
1.3.5 | 228 | 7/3/2023 | |
1.3.4 | 203 | 7/3/2023 | |
1.3.3 | 246 | 7/3/2023 | |
1.3.2 | 219 | 6/26/2023 | |
1.3.1 | 232 | 4/21/2023 | |
1.2.9 | 319 | 2/22/2023 | |
1.2.8 | 295 | 2/16/2023 | |
1.2.7 | 310 | 2/16/2023 | |
1.2.6 | 326 | 2/11/2023 | |
1.2.5 | 343 | 2/10/2023 | |
1.2.4 | 320 | 2/10/2023 | |
1.2.3 | 373 | 12/9/2022 | |
1.2.2 | 374 | 12/9/2022 | |
1.2.1 | 361 | 12/8/2022 | |
1.2.0 | 362 | 12/8/2022 | |
1.1.9 | 364 | 12/8/2022 | |
1.1.8 | 357 | 12/8/2022 | |
1.1.7 | 400 | 12/8/2022 | |
1.1.6 | 368 | 12/6/2022 | |
1.1.5 | 368 | 12/6/2022 | |
1.1.4 | 376 | 12/6/2022 | |
1.1.3 | 385 | 12/6/2022 | |
1.1.2 | 382 | 12/6/2022 | |
1.1.1 | 414 | 11/12/2022 | |
1.1.0 | 417 | 11/9/2022 | |
1.0.9 | 408 | 11/9/2022 | |
1.0.8 | 453 | 11/9/2022 | |
1.0.7 | 459 | 10/21/2022 | |
1.0.6 | 463 | 10/13/2022 | |
1.0.5 | 488 | 10/12/2022 | |
1.0.4 | 474 | 10/12/2022 | |
1.0.3 | 477 | 10/12/2022 | |
1.0.2 | 460 | 10/11/2022 | |
1.0.1 | 457 | 10/4/2022 | |
1.0.0 | 489 | 8/16/2022 |