Skip to content
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.

Sign up for GitHub

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

Updating docs for itemId for Mail and Calendar #2400

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Updating docs for itemId for Mail and Calendar #2400

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6df17d8
Updating docs for itemId for Mail and Calendar
vikramtha Jul 10, 2024
3b8f55d
changefile
vikramtha Jul 10, 2024
0480891
removed accidental file
vikramtha Jul 10, 2024
4a3a0b7
Merge branch 'main' into vikramtha/updatingitemIDforMailandCalendardocs
AE-MS Jul 11, 2024
3037d91
Update @microsoft-teams-js-d0373412-a60a-4bee-8468-77ff80125588.json
AE-MS Jul 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions change/@microsoft-teams-js-d0373412-a60a-4bee-8468-77ff80125588.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "none",
"comment": "Updated documentation on IDs for `mail` and `calendar` capability",
"packageName": "@microsoft/teams-js",
"email": "vikramtha@microsoft.com",
"dependentChangeType": "none"
}
6 changes: 5 additions & 1 deletion packages/teams-js/src/public/calendar.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,11 @@ export namespace calendar {

/** Open calendar item parameters. */
export interface OpenCalendarItemParams {
/** An unique base64-encoded string id that represents the event's unique identifier of the calendar item to be opened. */
/** An unique base64-encoded string id that represents the itemId or messageId.
* The only acceptable id for this itemId is the EWS (Exchange Web Services) ID. However,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

EWS (Exchange Web Services) ID

Is there a public documentation link that describes what the EWS ID is? Your explanation for how to create it from the graph ID is very helpful and probably sufficient but if we have a doc link that would be a good addition.

* if you are using Graph API, you must convert the REST ID to a EWS ID. The conversion is done by
* replacing "+" characters with "-" and "/" characters with "_".
*/
itemId: string;
}

Expand Down
6 changes: 5 additions & 1 deletion packages/teams-js/src/public/mail.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,11 @@ export namespace mail {

/** Defines the parameters used to open a mail item in the user's mailbox */
export interface OpenMailItemParams {
/** An unique base64-encoded string id that represents the itemId or messageId. */
/** An unique base64-encoded string id that represents the itemId or messageId.
* The only acceptable id for this itemId is the EWS (Exchange Web Services) ID. However,
* if you are using Graph API, you must convert the REST ID to a EWS ID. The conversion is done by
* replacing "+" characters with "-" and "/" characters with "_".
*/
itemId: string;
}

Expand Down
Loading