Struct GraphClient

Source

pub struct GraphClient { /* private fields */ }

Implementations§

Source §

impl GraphClient

Source

pub fn new<AT: ToString>(access_token: AT) -> GraphClient

Source

pub fn from_client_app<CA: ClientApplication + 'static>( client_app: CA, ) -> GraphClient

Source

pub fn v1(&mut self) -> &mut GraphClient

Use the v1 endpoint for the Microsoft Graph API. This is the default endpoint used by the client.

§Example

use graph_rs_sdk::Graph;

let mut client = Graph::new("ACCESS_TOKEN");

client.v1()
    .me()
    .get_user()
    .send()
    .await?;

Source

pub fn use_v1(&mut self)

Use the v1 endpoint for the Microsoft Graph API. Same as calling v1() but takes a mutable reference to self and does not return self.

§Example

use graph_rs_sdk::Graph;

let mut client = Graph::new("ACCESS_TOKEN");
client.use_v1();

assert_eq!(client.url().to_string(), GRAPH_URL.to_string())

Source

pub fn beta(&mut self) -> &mut GraphClient

Use the beta endpoint for the Microsoft Graph API

§Example

use graph_rs_sdk::Graph;

let mut client = Graph::new("ACCESS_TOKEN");

client.beta()
    .me()
    .get_user()
    .send()
    .await?;

Source

pub fn use_beta(&mut self)

Use the beta endpoint for the Microsoft Graph API. Same as calling beta() but takes a mutable reference to self and does not return self.

Example

use graph_rs_sdk::Graph;

let mut client = Graph::new("ACCESS_TOKEN");
client.use_beta();

assert_eq!(client.url().to_string(), GRAPH_URL_BETA.to_string())

Source

pub fn url(&self) -> &Url

Source

pub fn with_force_token_refresh( &mut self, force_token_refresh: ForceTokenRefresh, ) -> &mut Self

Source

pub fn use_force_token_refresh( &mut self, force_token_refresh: ForceTokenRefresh, )

Source

pub fn custom_endpoint(&mut self, url: &Url) -> &mut GraphClient

Set a custom endpoint for the Microsoft Graph API. Provide the scheme and host with an optional path. The path is not set by the sdk when using a custom endpoint.

The scheme must be https:// and any other provided scheme will cause a panic. See Microsoft Graph Service Root Endpoints

Attempting to use an invalid host will cause the client to panic. This is done for increased security.

Do not use a government host endpoint without authorization and any necessary clearances. Using any government host endpoint means you should expect every API call will be monitored and recorded.

You should also assume China’s Graph API operated by 21Vianet is being monitored by the Chinese government who is well known for the control it has over Chinese companies and for its surveillance state of Chinese citizens. And, according to Microsoft, These services are subject to Chinese laws. See Microsoft 365 operated by 21Vianet

Valid Hosts:

graph.microsoft.com (Default public endpoint worldwide)
graph.microsoft.us (U.S. Government)
dod-graph.microsoft.us (U.S. Department Of Defense)
graph.microsoft.de
microsoftgraph.chinacloudapi.cn (operated by 21Vianet)
canary.graph.microsoft.com

Example

use graph_rs_sdk::Graph;

let mut client = Graph::new("ACCESS_TOKEN");

client.custom_endpoint("https://graph.microsoft.com/v1.0")
    .me()
    .get_user()
    .send()
    .await?;

Source

pub fn use_endpoint(&mut self, url: &Url)

Set a custom endpoint for the Microsoft Graph API. Provide the scheme and host with an optional path. The path is not set by the sdk when using a custom endpoint.

The scheme must be https:// and any other provided scheme will cause a panic. See Microsoft Graph Service Root Endpoints

Attempting to use an invalid host will cause the client to panic. This is done for increased security.

Do not use a government host endpoint without authorization and any necessary clearances. Using any government host endpoint means you should expect every API call will be monitored and recorded.

You should also assume China’s Graph API operated by 21Vianet is being monitored by the Chinese government who is well known for the control it has over Chinese companies and for its surveillance state of Chinese citizens. And, according to Microsoft, These services are subject to Chinese laws. See Microsoft 365 operated by 21Vianet

Valid Hosts:

graph.microsoft.com (Default public endpoint worldwide)
graph.microsoft.us (U.S. Government)
dod-graph.microsoft.us (U.S. Department Of Defense)
graph.microsoft.de
microsoftgraph.chinacloudapi.cn (operated by 21Vianet)
canary.graph.microsoft.com

Example

use url::Url;
use graph_rs_sdk::Graph;

let mut client = Graph::new("ACCESS_TOKEN");
client.use_endpoint(&Url::parse("https://graph.microsoft.com/v1.0").unwrap());

assert_eq!(client.url().to_string(), "https://graph.microsoft.com/v1.0".to_string())

Source