Enable app icon badging for your Teams app
App icon badging helps a meeting participant identify any app activity during a meeting. Participants get activity notification for the meeting apps.
When there's new activity during the meeting, the app calls the
targetedMeetingNotification API and displays a red badge on the app icon in the meeting unified bar (U-bar). When the participant selects the app icon, the app opens in the meeting side panel, and the badge goes away.
For example, during a real time collaboration in a meeting, if a participant adds a comment in a file added to the meeting, the app calls the
targetedMeetingNotification API from the participant's meeting side panel. The API triggers a badge on the app icon to make other participants aware of the comment activity.
The following image shows you the app icon badging in the meeting U-bar:
- App icon badging isn't available for Government Community Cloud (GCC)-High and Department of Defense (DOD) environments.
- App icon badging isn't supported for mobile clients.
- App icon badging isn't supported for channel meetings.
To enable app icon badging, follow these steps:
Enable app manifest settings for app icon badging
To enable app icon badging, you must:
- Ensure that you've configured
contextproperty for your app.
- Configure the
authorizationproperty and the
typeproperties under the
resourceSpecificfield in the app manifest as follows:
"resource": "https://RscBasedStoreApp" },
"type": "Application" }
Enable app icon badging for your app
To enable app icon badging, ensure that you've enabled targeted in-meeting notification.
The Targeted meeting notification and app icon badging API is extended to support the app icon badging capability on the app icon and pass the user MRI IDs of the intended recipients. The
surfaces parameter now supports
meetingTabIcon value, which is used by the app.
App can also pass the
tabEntityId, if there are multiple instances of the app added to the same meeting. If the
tabEntityId isn't passed, then Teams displays the badge on the first app icon on the users meeting window.
TeamsInfo.SendMeetingNotificationAsync(context, notificationPayload, meetingId);
The following table includes the response codes:
|Notification is successfully sent.
|Notifications are sent only to a few participants.
|Meeting notification request payload validation failed.
|Bot token is invalid.
|Bot isn't allowed to send the notification.
|Meeting chat isn't found or none of the participants were found in the roster.
App icon badging displays only one notification for a user in a minute per meeting.
App icon badging is displayed to a maximum of first 50 participants for a particular meeting.
|App icon badging for your Teams app
|This sample demonstrates how to enable app icon badging for your Teams app.