Microsoft 365 Community Viva Connections, 24 Apr 2023

Previous Meeting Next Meeting

⏯

youtube image

►

From YouTube: Viva Connections extension with user presence status using Microsoft Graph Presence API and SPFx

Description

In this 10-minute developer-focused demo, Yves Habersaat delivers an introduction to the Graph Presence API, API methods, presence sessions, presence sessions with SPFx, a setPresence method example, and suggestion to use Graph Explorer to experiment with API. This ACE demonstrates how to use the Presence Graph API endpoints (beta) to set and retrieve a presence status message for a user. Set/update a user’s presence – their availability and a message to viewers. Sample contains wide range of capabilities.

This PnP Community demo is taken from the Viva Connections & SharePoint Framework Bi-weekly sync call recorded on March 23, 2023.

Demo Presenter
• Yves Habersaat (Sword Group) | @yhabersaat

Supporting materials
• Sample - BasicCard-StatusMessage | https://github.com/pnp/sp-dev-fx-aces/tree/main/samples/BasicCard-StatusMessage
• Tool – Graph Explorer | aka.ms/ge

Learn more
• Microsoft 365 Unified Sample gallery - https://aka.ms/community/samples
• Microsoft 365 Platform Community in YouTube - https://aka.ms/community/videos
• Microsoft 365 Platform Community - http://aka.ms/community/home

A

A

A

Just a few words about me before my name is word group as a consultant, so I'm doing a lot of different things regarding to Microsoft 365, Azure, Dynamics, 365, and also a proper thumb I'm living in Switzerland I'm, a Microsoft MVP, m265 development and Microsoft Microsoft certificate. Trainer also so feel free to reach me out on my social and website. If you have any question or query to ask so for today, I will talk about Microsoft graph presence API.

A

Actually you have a V1 endpoint, but for this sample, I took the B type beta in point, sorry to have a larger wide of capabilities, and all this API are collected to the user's presence. For example, you have capabilities like you can get the resource presence you can set the users presence, you can clear the user's presence set a status message and also you can track. You can track the user's presence with a change notification and a little bit more for the available API method.

A

You have a wide range of method like uh to get the presence you can get the presence of multiple users. You can set the presence here. The present you can set in here the user preferred present and also set a user status message. I've highlighted the concept of session of an application that is really important to understand and basically I will describe to you. What is it and basically, to use some of these API method.

A

You need to pass the ID of the present session and basically, what it means you can have multiple present session that can be active simuldaneously and for specific reasons like, for example, if you are using multiple teams- client, if you have the web desktop and mobile client, but also if you have Ace web art or any line of business applications that interact with the API.

A

So for this return you have the concept of present session and each session May time out and expire, so the application or whatever it could be ace web part or whatever needs to call the API before the expiration in order to keep the session alive. And if you can't keep the session alive, it will reset to the default status.

A

State sorry, with SP effects a little bit important to understand because, for example, when you are developing, for example, with the spfx latest version you you can use Ms graph client D3 to connect to Microsoft graph API and behind the scene is implements uh as you can, as you might know, Azure ID, Pro and pro the shop.9 client extended service principle and basically behind the scene. The session ID parameter that is required in some method is nothing other than this application, ID or service principle in Azure age. This is what you will.

A

It works for spfx, uh just an example of how to set the presence of a user. You have two endpoints me or users in the first, you need to provide the user ID and the second is for the current user and, as you can see, you have a body and you have session ID, which is a service principle ID of sharpent online, and you have also availability and activity, and all these parameters are a fixed list of combination.

A

You cannot Set uh what you want, it's fixed to fix list and you have also an expiration duration. uh It's a nizo, 86101 format default is five minutes PT 500, but in this example you see pt2h 30m, which is 2 hours and 30 minutes.

A

This is a concrete example of how to set the present uh and also, if you want to play like I, am like I've done. You can use the graph Explorer to deal with some uh endpoints and it's it's a great tool if you want to start playing with this API now, just a quick demo, because this sample just implements a lot of different method to just show you how it works, so I will switch to my visual studio. So here this is the sample.

A

The latest version, because the first version I've submitted is not really it's really simple and in this sample, which will be available as soon as the pull request will be approved, will contain a wide range of different capabilities. So I will just show you how it works. So this is the age and basically you see you have the status message and actually I don't have any status message defined. If I click on this button, you see you have a an interface and I.

A

Can provide, for example, my status message, which is, for example, hello, m2c community, like this I can put a status message: expiration, for example, I will choose four hours and you can set also the availability based on the combinations uh you can provide. So, for example, I will put do not disturb if I submit. No, it's okay, I will close, and you see now I have my status message to prove you that is working. So yes, I'm presenting and the the status message is really a good set with a display.

A

Until uh tonight it's really working and after, for example, you can clear the availability. If you want this, will reset my availability to available or your preferred presence status. You see it's really working so I'm available now, and you can also just clear the status message to get everything back to the initial state and I will prove you that everything is okay. You see no status message, it's okay! So now the code I will show you a little bit of code now because it's interesting uh I'm playing with two entities.

A

The first is a present status, which represents nothing other than a presentation with the session, ID, availability activity and exploration duration, and the second thing is the status message entity. So you see I have the message. You have a content and a content type in my case, which will be text, and you have also the xpv date time which uh which have the time and the time zone UTC by default, and this kind of stuff after I have made this little service, which basically expose everything uh to play with this API.

A

So, for example, I have a first method that is called get the equivalent user status message, I'm just getting the status message of the current user through the MS graph client V3.

A

The second one is, you can set the current user status message, I'm, just getting a status message and an expiration and, as you can see, I'm just calling this method and after based on what I've provided uh as choice, I can just put an expiration date and, after I have received this eye status. Message object, which is my request, body and I'm, putting my status message and the expiration date, which is in the iso format and UTC as a time zone. But if you want you can provide the different time zone. Also.

A

uh I'm also have a method that just get the Korean Twitter ID. If you need, because some endpoints requires the user ID. So you have this method and you can also you see, set the current user availability. So it's a set presence and in this case, I'm just providing a present status and after I'm just setting all these. These things to the current user and the last thing is the get current user session ID. As I told you, you need to request the specific service principle.

A

So you see you have an endpoint for that application and I'm just getting the nap the app ID of this service principle behind the scene to be able to call correctly all this kind of API and after you have also the clear presence.

A

I know you see also in the clear presence you need to provide and specify the session ID. It's mandatory to set the present and to clear the present, and this is the sample.

A

uh Basically I can just show you the quick view, because it's really uh it's really simple, not really Advanced, but you see you have on action, method and I'm, providing everything to call this kind of of API, and basically you have everything uh we deal and to interact with in this API, basically that soul on my side and basically back to you, will go wonderful. Thank you. So much foreign.