Skip to content

[Outlook] Update and map appointment date snippets #1018

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

Merged
merged 3 commits into from
Oct 27, 2025
Merged

[Outlook] Update and map appointment date snippets #1018

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ea88ceb
Update appointment date APIs
samantharamon Oct 25, 2025
b59d990
Apply suggestions from code review
samantharamon Oct 27, 2025
448e90f
Run script
samantharamon Oct 27, 2025
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
21 changes: 16 additions & 5 deletions samples/outlook/90-other-item-apis/get-end-read.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,18 @@ api_set:
Mailbox: '1.1'
script:
content: |-
document.getElementById("get").addEventListener("click", get);
document.getElementById("get-utc").addEventListener("click", getUtc);
document.getElementById("get-local").addEventListener("click", getLocal);

function get() {
console.log(`Appointment ends: ${Office.context.mailbox.item.end}`);
function getUtc() {
const time = Office.context.mailbox.item.end;
console.log(`Appointment ends (UTC): ${time.toUTCString()}`);
}

function getLocal() {
const time = Office.context.mailbox.item.end;
const localTime = Office.context.mailbox.convertToLocalClientTime(time);
console.log(`Appointment ends (local): ${localTime.month + 1}/${localTime.date}/${localTime.year}, ${localTime.hours}:${localTime.minutes}:${localTime.seconds}`);
}
language: typescript
template:
Expand All @@ -22,8 +30,11 @@ template:
<section class="ms-Fabric samples ms-font-m">
<h3>Try it out</h3>
<button id="get" class="ms-Button">
<div class="ms-Button-label">Get end date and time</div>
</button>
<div class="ms-Button-label">Get end date and time (UTC)</div>
</button>
<button id="get-local" class="ms-Button">
<div class="ms-Button-label">Get end date and time (local)</div>
</button>
</section>
language: html
style:
Expand Down
33 changes: 26 additions & 7 deletions samples/outlook/90-other-item-apis/get-set-end-appointment-organizer.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,32 @@ api_set:
Mailbox: '1.1'
script:
content: |-
document.getElementById("get").addEventListener("click", get);
document.getElementById("get-utc").addEventListener("click", getUtc);
document.getElementById("get-local").addEventListener("click", getLocal);
document.getElementById("set").addEventListener("click", set);

function get() {
function getUtc() {
Office.context.mailbox.item.end.getAsync((result) => {
if (result.status !== Office.AsyncResultStatus.Succeeded) {
console.error(`Action failed with message ${result.error.message}`);
return;
}
console.log(`Appointment ends: ${result.value}`);

const time = result.value;
console.log(`Appointment ends (UTC): ${time.toUTCString()}`);
});
}

function getLocal() {
Office.context.mailbox.item.end.getAsync((result) => {
if (result.status !== Office.AsyncResultStatus.Succeeded) {
console.error(`Action failed with message ${result.error.message}`);
return;
}

const time = result.value;
const localTime = Office.context.mailbox.convertToLocalClientTime(time);
console.log(`Appointment ends (local): ${localTime.month + 1}/${localTime.date}/${localTime.year}, ${localTime.hours}:${localTime.minutes}:${localTime.seconds}`);
});
}

Expand Down Expand Up @@ -50,9 +66,12 @@ template:
<button id="set" class="ms-Button">
<div class="ms-Button-label">Set end date and time</div>
</button>
<button id="get" class="ms-Button">
<div class="ms-Button-label">Get end date and time</div>
</button>
<button id="get-utc" class="ms-Button">
<div class="ms-Button-label">Get end date and time (UTC)</div>
</button>
<button id="get-local" class="ms-Button">
<div class="ms-Button-label">Get end date and time (local)</div>
</button>
</section>
language: html
style:
Expand All @@ -73,4 +92,4 @@ libraries: |-
https://appsforoffice.microsoft.com/lib/1/hosted/office.d.ts

https://unpkg.com/office-ui-fabric-core@11.1.0/dist/css/fabric.min.css
https://unpkg.com/office-ui-fabric-js@1.5.0/dist/css/fabric.components.min.css
https://unpkg.com/office-ui-fabric-js@1.5.0/dist/css/fabric.components.min.css
31 changes: 25 additions & 6 deletions samples/outlook/90-other-item-apis/get-set-start-appointment-organizer.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,32 @@ api_set:
Mailbox: '1.1'
script:
content: |-
document.getElementById("get").addEventListener("click", get);
document.getElementById("get-utc").addEventListener("click", getUtc);
document.getElementById("get-local").addEventListener("click", getLocal);
document.getElementById("set").addEventListener("click", set);

function get() {
function getUtc() {
Office.context.mailbox.item.start.getAsync((result) => {
if (result.status !== Office.AsyncResultStatus.Succeeded) {
console.error(`Action failed with message ${result.error.message}`);
return;
}
console.log(`Appointment starts: ${result.value}`);

const time = result.value;
console.log(`Appointment starts (UTC): ${time.toUTCString()}`);
});
}

function getLocal() {
Office.context.mailbox.item.start.getAsync((result) => {
if (result.status !== Office.AsyncResultStatus.Succeeded) {
console.error(`Action failed with message ${result.error.message}`);
return;
}

const time = result.value;
const localTime = Office.context.mailbox.convertToLocalClientTime(time);
console.log(`Appointment starts (local): ${localTime.month + 1}/${localTime.date}/${localTime.year}, ${localTime.hours}:${localTime.minutes}:${localTime.seconds}`);
});
}

Expand All @@ -43,9 +59,12 @@ template:
<button id="set" class="ms-Button">
<div class="ms-Button-label">Set start date and time</div>
</button>
<button id="get" class="ms-Button">
<div class="ms-Button-label">Get start date and time</div>
</button>
<button id="get-utc" class="ms-Button">
<div class="ms-Button-label">Get start date and time (UTC)</div>
</button>
<button id="get-local" class="ms-Button">
<div class="ms-Button-label">Get start date and time (local)</div>
</button>
</section>
language: html
style:
Expand Down
23 changes: 17 additions & 6 deletions samples/outlook/90-other-item-apis/get-start-read.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,18 @@ api_set:
Mailbox: '1.1'
script:
content: |-
document.getElementById("get").addEventListener("click", get);
document.getElementById("get-utc").addEventListener("click", getUtc);
document.getElementById("get-local").addEventListener("click", getLocal);

function get() {
console.log(`Appointment starts: ${Office.context.mailbox.item.start}`);
function getUtc() {
const time = Office.context.mailbox.item.start;
console.log(`Appointment starts (UTC): ${time.toUTCString()}`);
}

function getLocal() {
const time = Office.context.mailbox.item.start;
const localTime = Office.context.mailbox.convertToLocalClientTime(time);
console.log(`Appointment starts (local): ${localTime.month + 1}/${localTime.date}/${localTime.year}, ${localTime.hours}:${localTime.minutes}:${localTime.seconds}`);
}
language: typescript
template:
Expand All @@ -21,9 +29,12 @@ template:
</section>
<section class="ms-Fabric samples ms-font-m">
<h3>Try it out</h3>
<button id="get" class="ms-Button">
<div class="ms-Button-label">Get start date and time</div>
</button>
<button id="get-utc" class="ms-Button">
<div class="ms-Button-label">Get start date and time (UTC)</div>
</button>
<button id="get-local" class="ms-Button">
<div class="ms-Button-label">Get start date and time (local)</div>
</button>
</section>
language: html
style:
Expand Down
Binary file modified snippet-extractor-metadata/outlook.xlsx
View file
Open in desktop
Binary file not shown.
73 changes: 66 additions & 7 deletions snippet-extractor-output/snippets.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9330,7 +9330,10 @@ Office.AppointmentCompose#end:member:
console.error(`Action failed with message ${result.error.message}`);
return;
}
console.log(`Appointment ends: ${result.value}`);

const time = result.value;
const localTime = Office.context.mailbox.convertToLocalClientTime(time);
console.log(`Appointment ends (local): ${localTime.month + 1}/${localTime.date}/${localTime.year}, ${localTime.hours}:${localTime.minutes}:${localTime.seconds}`);
});
- >-
// Link to full sample:
Expand Down Expand Up @@ -10062,7 +10065,10 @@ Office.AppointmentCompose#start:member:
console.error(`Action failed with message ${result.error.message}`);
return;
}
console.log(`Appointment starts: ${result.value}`);

const time = result.value;
const localTime = Office.context.mailbox.convertToLocalClientTime(time);
console.log(`Appointment starts (local): ${localTime.month + 1}/${localTime.date}/${localTime.year}, ${localTime.hours}:${localTime.minutes}:${localTime.seconds}`);
});
- >-
// Link to full sample:
Expand Down Expand Up @@ -10448,7 +10454,13 @@ Office.AppointmentRead#end:member:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-end-read.yaml


console.log(`Appointment ends: ${Office.context.mailbox.item.end}`);
const time = Office.context.mailbox.item.end;

const localTime = Office.context.mailbox.convertToLocalClientTime(time);

console.log(`Appointment ends (local): ${localTime.month +
1}/${localTime.date}/${localTime.year},
${localTime.hours}:${localTime.minutes}:${localTime.seconds}`);
Office.AppointmentRead#enhancedLocation:member:
- >-
// Link to full sample:
Expand Down Expand Up @@ -10786,7 +10798,13 @@ Office.AppointmentRead#start:member:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-start-read.yaml


console.log(`Appointment starts: ${Office.context.mailbox.item.start}`);
const time = Office.context.mailbox.item.start;

const localTime = Office.context.mailbox.convertToLocalClientTime(time);

console.log(`Appointment starts (local): ${localTime.month +
1}/${localTime.date}/${localTime.year},
${localTime.hours}:${localTime.minutes}:${localTime.seconds}`);
Office.AppointmentRead#subject:member:
- >-
// Link to full sample:
Expand Down Expand Up @@ -11845,6 +11863,19 @@ Office.Item:interface:
console.log(`Current item is a ${itemType}. A message could be an email, meeting request, meeting response, or meeting cancellation.`);
break;
}
Office.LocalClientTime:interface:
- >-
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-start-read.yaml


const time = Office.context.mailbox.item.start;

const localTime = Office.context.mailbox.convertToLocalClientTime(time);

console.log(`Appointment starts (local): ${localTime.month +
1}/${localTime.date}/${localTime.year},
${localTime.hours}:${localTime.minutes}:${localTime.seconds}`);
Office.Location#getAsync:member(2):
- >-
// Link to full sample:
Expand Down Expand Up @@ -11902,6 +11933,19 @@ Office.Mailbox#convertToEwsId:member(1):
Office.MailboxEnums.RestVersion.v2_0);

console.log("EWS ID (from REST ID): " + ewsId2);
Office.Mailbox#convertToLocalClientTime:member(1):
- >-
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-start-read.yaml


const time = Office.context.mailbox.item.start;

const localTime = Office.context.mailbox.convertToLocalClientTime(time);

console.log(`Appointment starts (local): ${localTime.month +
1}/${localTime.date}/${localTime.year},
${localTime.hours}:${localTime.minutes}:${localTime.seconds}`);
Office.Mailbox#convertToRestId:member(1):
- >-
// Link to full sample:
Expand Down Expand Up @@ -14324,7 +14368,13 @@ Office.MessageRead#end:member:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-end-read.yaml


console.log(`Appointment ends: ${Office.context.mailbox.item.end}`);
const time = Office.context.mailbox.item.end;

const localTime = Office.context.mailbox.convertToLocalClientTime(time);

console.log(`Appointment ends (local): ${localTime.month +
1}/${localTime.date}/${localTime.year},
${localTime.hours}:${localTime.minutes}:${localTime.seconds}`);
Office.MessageRead#from:member:
- >-
// Link to full sample:
Expand Down Expand Up @@ -14659,7 +14709,13 @@ Office.MessageRead#start:member:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/outlook/90-other-item-apis/get-start-read.yaml


console.log(`Appointment starts: ${Office.context.mailbox.item.start}`);
const time = Office.context.mailbox.item.start;

const localTime = Office.context.mailbox.convertToLocalClientTime(time);

console.log(`Appointment starts (local): ${localTime.month +
1}/${localTime.date}/${localTime.year},
${localTime.hours}:${localTime.minutes}:${localTime.seconds}`);
Office.MessageRead#subject:member:
- >-
// Link to full sample:
Expand Down Expand Up @@ -15567,7 +15623,10 @@ Office.Time#getAsync:member(2):
console.error(`Action failed with message ${result.error.message}`);
return;
}
console.log(`Appointment starts: ${result.value}`);

const time = result.value;
const localTime = Office.context.mailbox.convertToLocalClientTime(time);
console.log(`Appointment starts (local): ${localTime.month + 1}/${localTime.date}/${localTime.year}, ${localTime.hours}:${localTime.minutes}:${localTime.seconds}`);
});
Office.Time#setAsync:member(1):
- >-
Expand Down