-
Notifications
You must be signed in to change notification settings - Fork 525
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Doc Feature][Custom activity icons in activity feed notifications][3679852] #12543
base: main
Are you sure you want to change the base?
Conversation
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
Co-authored-by: Copilot <[email protected]>
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added my review comments.
@@ -13,6 +13,7 @@ An app package is a file format that has the required resources to install and r | |||
|
|||
* **[App manifest](#app-manifest)**: Describes how your app is configured, including its capabilities, required resources, and other important attributes. | |||
* **[App icons](#app-icons)**: Each package requires a color and outline icon for your app. | |||
* **[Custom activity icons](/graph/teams-send-activityfeednotifications?toc=%2Fmicrosoftteams%2Fplatform%2Ftoc.json&bc=%2Fmicrosoftteams%2Fplatform%2Fbreadcrumb%2Ftoc.json&tabs=desktop%2Chttp#custom-activity-icons-in-activity-feed-notifications)**: Tailor-made icons that you can use in activity feed notifications. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can't we redirect to specific section which actually explains how to configure it and what configuration we need to add it in the manifest?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ChetanSharma-msft, the link redirects to the specific section on how to configure it and what configuration we need to add it in the manifest. However, since the PR in the graph docs isn't live yet, it redirects to the top of the page.
@@ -40,6 +40,10 @@ The following variants show the kinds of activity feed notification cards you ca | |||
|
|||
:::image type="content" source="../../assets/images/activity-feed/activity-feed-card-types.png" alt-text="Variants of Teams activity feed cards." lightbox="../../assets/images/activity-feed/activity-feed-card-types.png"::: | |||
|
|||
## Custom activity icons | |||
|
|||
You can add custom activity icons in activity feed notifications to increase user engagement for your app. For more information, see [custom activity icons in activity feed notifications](/graph/teams-send-activityfeednotifications?toc=%2Fmicrosoftteams%2Fplatform%2Ftoc.json&bc=%2Fmicrosoftteams%2Fplatform%2Fbreadcrumb%2Ftoc.json&tabs=desktop%2Chttp#custom-activity-icons-in-activity-feed-notifications). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can't we redirect to specific section in the documentation?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ChetanSharma-msft, same as above.
@@ -46,6 +46,8 @@ landingContent: | |||
linkLists: | |||
- linkListType: whats-new | |||
links: | |||
- text: Use custom activity icons in activity feed notifications |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can't we redirect to specific section in the documentation?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ChetanSharma-msft, same as above.
@@ -888,53 +888,75 @@ Define the properties your app uses to post a user activity feed. | |||
|`type`|String|32 characters|✔️|The notification type.| | |||
|`description`|String|128 characters|✔️|A brief description of the notification.| | |||
|`templateText`|String|128 characters|✔️|Ex: "{actor} created task {taskId} for you"| | |||
|`allowedIconIds`|Array of strings| | |A list of custom icon IDs valid for that activity.| |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we check Maximum Size with the Engineering team and update it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ChetanSharma-msft, I'll ask Mehak and update.
|
||
|Name| Type| Maximum size | Required | Description| | ||
|---|---|---|---|---| | ||
|`id`|String| |✔️|Defines the unique icon ID.| |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What are the maximum size for id and iconFIle?
Can we check with the Engineering team and update here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ChetanSharma-msft, Mehak mentioned that it was probably 20 but is yet to be confirmed. I have updated it as 20 for now.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@v-kushals as per dev's confirmation, please change 20 to 50. Thanks!
"description": "leadership Announcements", | ||
"templateText": "{actor} shared an announcement", | ||
"allowedIconIds" : [ | ||
"announcementCreated" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can't we put placeholders here if this is an example?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've updated the code snippet with placeholder names, @ChetanSharma-msft.
Acrolinx ScorecardsWe currently enforce a minimum score of 80. Click the scorecard links for each article to review the Acrolinx feedback on grammar, spelling, punctuation, writing style, and terminology:
More info about Acrolinx Use the Acrolinx extension, or sidebar, in Visual Studio Code to check spelling, grammar, style, tone, clarity, and key terminology when you're creating or updating content. For more information, see Use the Visual Studio Code extension to run Acrolinx locally. |
Learn Build status updates of commit 32cc1c0: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please address my comments, thank you for helping with these docs!
* The outline icon mustn't contain any additional padding around the symbol. | ||
* Ensure that the outline icon size is 32x32 pixels. | ||
* The icon must be either white with a transparent background or transparent with a white background. No other colors are allowed. | ||
* The outline icon mustn't contain any additional padding around the symbol. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Line 82 & 83: can we reuse the exact wording from store validation guidelines? @v-kushals
- The size of icon must be 32x32 pixels.
- The icon must be enterprise-safe.
- The icon can't be random or irrelevant and needs to match the information in the notification.
- The icon must be designed with good accessibility.
...-platform/concepts/deploy-and-publish/appsource/prepare/teams-store-validation-guidelines.md
Show resolved
Hide resolved
|
||
|Name| Type| Maximum size | Required | Description| | ||
|---|---|---|---|---| | ||
|`id`|String| |✔️|Defines the unique icon ID.| |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@v-kushals as per dev's confirmation, please change 20 to 50. Thanks!
} | ||
] | ||
} | ||
//... |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@v-kushals is "//..." required? Line 906 and line 956.
"type": "taskCreated", | ||
"description": "task created activity", | ||
"templateText": "Pradeep Gupta created a new task item for you.", | ||
// No icons are associated with this activity type. When you send a notification using this activity type, Teams shows the default brand logo. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"default brand logo" should be changed to "app icon". @v-kushals
No description provided.