From 12cd8beda97199a287280741b73f73c4f5ed96ff Mon Sep 17 00:00:00 2001 From: David Chesnut Date: Thu, 7 Aug 2025 10:10:38 -0700 Subject: [PATCH 1/2] [office-js,office-preview-js] exportAsBase64 and linked entity API comments. (#73345) --- types/office-js-preview/index.d.ts | 186 +++++++++++++++++++++++++++++ types/office-js/index.d.ts | 124 +++++++++++++++++++ 2 files changed, 310 insertions(+) diff --git a/types/office-js-preview/index.d.ts b/types/office-js-preview/index.d.ts index c1184659fb44cd..b8d9620fed8b25 100644 --- a/types/office-js-preview/index.d.ts +++ b/types/office-js-preview/index.d.ts @@ -31603,6 +31603,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This interface isn't supported in Excel on the web. */ interface LinkedEntityLoadServiceRequest { /** @@ -31610,6 +31612,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ domainId: string; /** @@ -31617,6 +31621,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ entities: LinkedEntityIdCulture[]; } @@ -31625,6 +31631,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This interface isn't supported in Excel on the web. */ interface LinkedEntityLoadServiceResult { /** @@ -31632,6 +31640,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ entities: LinkedEntityCellValue[]; } @@ -31676,6 +31686,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This interface isn't supported in Excel on the web. */ interface LinkedEntityIdCulture { /** @@ -31683,6 +31695,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ entityId: string; /** @@ -31690,6 +31704,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ culture: string; } @@ -60620,6 +60636,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This class isn't supported in Excel on the web. */ class LinkedEntityDataDomain extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -60630,6 +60648,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ readonly dataProvider: string; /** @@ -60638,6 +60658,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ readonly id: string; /** @@ -60646,6 +60668,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ readonly lastRefreshed: Date; /** @@ -60655,6 +60679,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ readonly loadFunctionId: string; /** @@ -60663,6 +60689,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ readonly name: string; /** @@ -60671,6 +60699,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ readonly periodicRefreshInterval: number; /** @@ -60680,6 +60710,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ refreshMode: Excel.LinkedEntityDataDomainRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic"; /** @@ -60689,6 +60721,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ readonly serviceId: number; /** @@ -60697,6 +60731,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ readonly supportedRefreshModes: Excel.LinkedEntityDataDomainRefreshMode[]; /** @@ -60706,6 +60742,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This method isn't supported in Excel on the web. */ delete(): void; /** @@ -60714,6 +60752,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This method isn't supported in Excel on the web. */ refresh(): void; /** @@ -60748,6 +60788,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This interface isn't supported in Excel on the web. */ interface LinkedEntityDataDomainAddedEventArgs { /** @@ -60756,6 +60798,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ id?: string; /** @@ -60763,6 +60807,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ serviceId: number; /** @@ -60770,6 +60816,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ source: Excel.EventSource | "Local" | "Remote"; /** @@ -60777,6 +60825,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ type: "LinkedEntityDataDomainLinkedEntityDataDomainAdded"; } @@ -60786,6 +60836,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This class isn't supported in Excel on the web. */ class LinkedEntityDataDomainCollection extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -60798,6 +60850,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This method isn't supported in Excel on the web. * * @param options Options that are used to create the linked entity data domain to be added. */ @@ -60807,6 +60861,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This method isn't supported in Excel on the web. */ getCount(): OfficeExtension.ClientResult; /** @@ -60814,6 +60870,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This method isn't supported in Excel on the web. * * @param id The `id` of the `LinkedEntityDataDomain` object to be retrieved. * @returns The linked entity data domain with the given `id`. If there are multiple linked entity data domains with the same `id`, the one defined by this Office Add-in will be returned. @@ -60824,6 +60882,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This method isn't supported in Excel on the web. * * @param index The index of the linked entity data domain in the collection. * @returns The linked entity data domain at the given index. @@ -60834,6 +60894,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This method isn't supported in Excel on the web. * * @param name The `name` of the `LinkedEntityDataDomain` object to be retrieved. * @returns The linked entity data domain with the given `name`. If there are multiple linked entity data domains with the same `name`, the one defined by this Office Add-in will be returned. @@ -60846,6 +60908,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This method isn't supported in Excel on the web. * * @param name The `name` of the `LinkedEntityDataDomain` object to be retrieved. * @returns The linked entity data domain with the given `name`. If there are multiple linked entity data domains with the same `name`, the one defined by this Office Add-in will be returned. @@ -60858,6 +60922,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This method isn't supported in Excel on the web. * * @param id The `id` of the `LinkedEntityDataDomain` object to be retrieved. * @returns The linked entity data domain with the given `id`. If there are multiple linked entity data domains with the same `id`, the one defined by this Office Add-in will be returned. @@ -60869,6 +60935,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This method isn't supported in Excel on the web. */ refreshAll(): void; /** @@ -60894,6 +60962,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This event isn't supported in Excel on the web. * * @eventproperty */ @@ -60903,6 +60973,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This event isn't supported in Excel on the web. * * @eventproperty */ @@ -60912,6 +60984,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This event isn't supported in Excel on the web. * * @eventproperty */ @@ -60927,6 +61001,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This interface isn't supported in Excel on the web. */ interface LinkedEntityDataDomainCreateOptions { /** @@ -60934,6 +61010,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ dataProvider: string; /** @@ -60942,6 +61020,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ id: string; /** @@ -60950,6 +61030,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ loadFunctionId: string; /** @@ -60958,6 +61040,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ name: string; /** @@ -60967,6 +61051,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ periodicRefreshInterval?: number; /** @@ -60978,6 +61064,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ supportedRefreshModes?: Excel.LinkedEntityDataDomainRefreshMode[]; } @@ -60986,6 +61074,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This interface isn't supported in Excel on the web. */ interface LinkedEntityDataDomainRefreshCompletedEventArgs { /** @@ -60993,6 +61083,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ errors?: string[]; /** @@ -61001,6 +61093,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ id?: string; /** @@ -61008,6 +61102,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ refreshed: boolean; /** @@ -61015,6 +61111,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ serviceId: number; /** @@ -61022,6 +61120,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ source: Excel.EventSource | "Local" | "Remote"; /** @@ -61029,6 +61129,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ type: "LinkedEntityDataDomainRefreshCompleted"; } @@ -61037,12 +61139,16 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This enum isn't supported in Excel on the web. */ enum LinkedEntityDataDomainRefreshMode { /** * Refresh mode is unknown or unsupported. * @remarks * [Api set: ExcelApi 1.19] + * + * This field isn't supported in Excel on the web. */ unknown = "Unknown", /** @@ -61050,6 +61156,8 @@ declare namespace Excel { Refresh is not triggered automatically. * @remarks * [Api set: ExcelApi 1.19] + * + * This field isn't supported in Excel on the web. */ manual = "Manual", /** @@ -61057,6 +61165,8 @@ declare namespace Excel { Refresh on add-in load, applicable to linked entity data domains defined by Office Add-ins. * @remarks * [Api set: ExcelApi 1.19] + * + * This field isn't supported in Excel on the web. */ onLoad = "OnLoad", /** @@ -61065,6 +61175,8 @@ declare namespace Excel { For linked entity data domains defined by Office Add-ins, this value also initiates a refresh each time the add-in loads. * @remarks * [Api set: ExcelApi 1.19] + * + * This field isn't supported in Excel on the web. */ periodic = "Periodic" } @@ -61073,6 +61185,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This interface isn't supported in Excel on the web. */ interface LinkedEntityDataDomainRefreshModeChangedEventArgs { /** @@ -61081,6 +61195,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ id?: string; /** @@ -61088,6 +61204,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ refreshMode: Excel.LinkedEntityDataDomainRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic"; /** @@ -61095,6 +61213,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ serviceId: number; /** @@ -61102,6 +61222,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ source: Excel.EventSource | "Local" | "Remote"; /** @@ -61109,6 +61231,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ type: "LinkedEntityDataDomainRefreshModeChanged"; } @@ -77436,6 +77560,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ refreshMode?: Excel.LinkedEntityDataDomainRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic"; } @@ -84576,6 +84702,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ dataProvider?: string; /** @@ -84584,6 +84712,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ id?: string; /** @@ -84592,6 +84722,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ lastRefreshed?: Date; /** @@ -84601,6 +84733,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ loadFunctionId?: string; /** @@ -84609,6 +84743,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ name?: string; /** @@ -84617,6 +84753,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ periodicRefreshInterval?: number; /** @@ -84626,6 +84764,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ refreshMode?: Excel.LinkedEntityDataDomainRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic"; /** @@ -84635,6 +84775,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ serviceId?: number; /** @@ -84643,6 +84785,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ supportedRefreshModes?: Excel.LinkedEntityDataDomainRefreshMode[]; } @@ -96667,6 +96811,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This interface isn't supported in Excel on the web. */ interface LinkedEntityDataDomainLoadOptions { /** @@ -96679,6 +96825,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ dataProvider?: boolean; /** @@ -96687,6 +96835,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ id?: boolean; /** @@ -96695,6 +96845,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ lastRefreshed?: boolean; /** @@ -96704,6 +96856,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ loadFunctionId?: boolean; /** @@ -96712,6 +96866,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ name?: boolean; /** @@ -96720,6 +96876,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ periodicRefreshInterval?: boolean; /** @@ -96729,6 +96887,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ refreshMode?: boolean; /** @@ -96738,6 +96898,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ serviceId?: boolean; /** @@ -96746,6 +96908,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ supportedRefreshModes?: boolean; } @@ -96755,6 +96919,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This interface isn't supported in Excel on the web. */ interface LinkedEntityDataDomainCollectionLoadOptions { /** @@ -96767,6 +96933,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ dataProvider?: boolean; /** @@ -96775,6 +96943,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ id?: boolean; /** @@ -96783,6 +96953,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ lastRefreshed?: boolean; /** @@ -96792,6 +96964,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ loadFunctionId?: boolean; /** @@ -96800,6 +96974,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ name?: boolean; /** @@ -96808,6 +96984,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ periodicRefreshInterval?: boolean; /** @@ -96817,6 +96995,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ refreshMode?: boolean; /** @@ -96826,6 +97006,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ serviceId?: boolean; /** @@ -96834,6 +97016,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ supportedRefreshModes?: boolean; } @@ -166287,6 +166471,8 @@ declare namespace PowerPoint { * * @remarks * [Api set: PowerPointApi 1.8] + * + * This method is optimized to export a single slide. Exporting multiple slides can impact performance. */ exportAsBase64(): OfficeExtension.ClientResult; /** diff --git a/types/office-js/index.d.ts b/types/office-js/index.d.ts index 02ef3f150bad5a..e912483adea951 100644 --- a/types/office-js/index.d.ts +++ b/types/office-js/index.d.ts @@ -30617,6 +30617,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This interface isn't supported in Excel on the web. */ interface LinkedEntityLoadServiceRequest { /** @@ -30624,6 +30626,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ domainId: string; /** @@ -30631,6 +30635,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ entities: LinkedEntityIdCulture[]; } @@ -30690,6 +30696,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This interface isn't supported in Excel on the web. */ interface LinkedEntityIdCulture { /** @@ -30697,6 +30705,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ entityId: string; /** @@ -30704,6 +30714,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ culture: string; } @@ -55863,6 +55875,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This class isn't supported in Excel on the web. */ class LinkedEntityDataDomain extends OfficeExtension.ClientObject { /** The request context associated with the object. This connects the add-in's process to the Office host application's process. */ @@ -55873,6 +55887,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ readonly dataProvider: string; /** @@ -55881,6 +55897,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ readonly id: string; /** @@ -55889,6 +55907,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ readonly lastRefreshed: Date; /** @@ -55898,6 +55918,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ readonly loadFunctionId: string; /** @@ -55906,6 +55928,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ readonly name: string; /** @@ -55914,6 +55938,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ readonly periodicRefreshInterval: number; /** @@ -55923,6 +55949,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ refreshMode: Excel.LinkedEntityDataDomainRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic"; /** @@ -55932,6 +55960,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ readonly serviceId: number; /** @@ -55940,6 +55970,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ readonly supportedRefreshModes: Excel.LinkedEntityDataDomainRefreshMode[]; /** @@ -55949,6 +55981,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This method isn't supported in Excel on the web. */ delete(): void; /** @@ -55957,6 +55991,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This method isn't supported in Excel on the web. */ refresh(): void; /** @@ -55991,6 +56027,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This interface isn't supported in Excel on the web. */ interface LinkedEntityDataDomainAddedEventArgs { /** @@ -55999,6 +56037,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ id?: string; /** @@ -56006,6 +56046,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ serviceId: number; /** @@ -56170,6 +56212,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This interface isn't supported in Excel on the web. */ interface LinkedEntityDataDomainCreateOptions { /** @@ -56177,6 +56221,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ dataProvider: string; /** @@ -56185,6 +56231,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ id: string; /** @@ -56193,6 +56241,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ loadFunctionId: string; /** @@ -56201,6 +56251,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ name: string; /** @@ -56210,6 +56262,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ periodicRefreshInterval?: number; /** @@ -56221,6 +56275,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ supportedRefreshModes?: Excel.LinkedEntityDataDomainRefreshMode[]; } @@ -56229,6 +56285,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This interface isn't supported in Excel on the web. */ interface LinkedEntityDataDomainRefreshCompletedEventArgs { /** @@ -56236,6 +56294,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ errors?: string[]; /** @@ -56244,6 +56304,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ id?: string; /** @@ -56251,6 +56313,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ refreshed: boolean; /** @@ -56258,6 +56322,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ serviceId: number; /** @@ -56265,6 +56331,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ source: Excel.EventSource | "Local" | "Remote"; /** @@ -56272,6 +56340,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ type: "LinkedEntityDataDomainRefreshCompleted"; } @@ -56316,6 +56386,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This interface isn't supported in Excel on the web. */ interface LinkedEntityDataDomainRefreshModeChangedEventArgs { /** @@ -56324,6 +56396,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ id?: string; /** @@ -56331,6 +56405,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ refreshMode: Excel.LinkedEntityDataDomainRefreshMode | "Unknown" | "Manual" | "OnLoad" | "Periodic"; /** @@ -56338,6 +56414,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ serviceId: number; /** @@ -56345,6 +56423,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ source: Excel.EventSource | "Local" | "Remote"; /** @@ -56352,6 +56432,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ type: "LinkedEntityDataDomainRefreshModeChanged"; } @@ -90658,6 +90740,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This interface isn't supported in Excel on the web. */ interface LinkedEntityDataDomainLoadOptions { /** @@ -90670,6 +90754,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ dataProvider?: boolean; /** @@ -90678,6 +90764,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ id?: boolean; /** @@ -90686,6 +90774,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ lastRefreshed?: boolean; /** @@ -90695,6 +90785,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ loadFunctionId?: boolean; /** @@ -90703,6 +90795,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ name?: boolean; /** @@ -90711,6 +90805,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ periodicRefreshInterval?: boolean; /** @@ -90720,6 +90816,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ refreshMode?: boolean; /** @@ -90729,6 +90827,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ serviceId?: boolean; /** @@ -90737,6 +90837,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ supportedRefreshModes?: boolean; } @@ -90746,6 +90848,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This interface isn't supported in Excel on the web. */ interface LinkedEntityDataDomainCollectionLoadOptions { /** @@ -90758,6 +90862,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ dataProvider?: boolean; /** @@ -90766,6 +90872,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ id?: boolean; /** @@ -90774,6 +90882,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ lastRefreshed?: boolean; /** @@ -90783,6 +90893,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ loadFunctionId?: boolean; /** @@ -90791,6 +90903,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ name?: boolean; /** @@ -90799,6 +90913,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ periodicRefreshInterval?: boolean; /** @@ -90808,6 +90924,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ refreshMode?: boolean; /** @@ -90817,6 +90935,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ serviceId?: boolean; /** @@ -90825,6 +90945,8 @@ declare namespace Excel { * * @remarks * [Api set: ExcelApi 1.19] + * + * This property isn't supported in Excel on the web. */ supportedRefreshModes?: boolean; } @@ -131472,6 +131594,8 @@ declare namespace PowerPoint { * * @remarks * [Api set: PowerPointApi 1.8] + * + * This method is optimized to export a single slide. Exporting multiple slides can impact performance. */ exportAsBase64(): OfficeExtension.ClientResult; /** From f3c4306d7f3b710b4087d2c1c0eb3a19973b516e Mon Sep 17 00:00:00 2001 From: Sam Ramon <15154970+samantharamon@users.noreply.github.com> Date: Thu, 7 Aug 2025 10:19:05 -0700 Subject: [PATCH 2/2] [office-js][office-js-preview] (Outlook) Update support for the Recipients API in Outlook on mobile devices (#73235) --- types/office-js-preview/index.d.ts | 24 ++++++++++++------------ types/office-js/index.d.ts | 24 ++++++++++++------------ 2 files changed, 24 insertions(+), 24 deletions(-) diff --git a/types/office-js-preview/index.d.ts b/types/office-js-preview/index.d.ts index b8d9620fed8b25..a8cb1ae9a91880 100644 --- a/types/office-js-preview/index.d.ts +++ b/types/office-js-preview/index.d.ts @@ -22294,9 +22294,8 @@ declare namespace Office { * - In Outlook on the web, on Windows (new and classic), and on Mac (classic UI), you can have a maximum of 500 recipients in a target field. * If you need to add more than 100 recipients to a mail item, you can call `addAsync` repeatedly, but be mindful of the recipient limit of the field. * - * - In Outlook on Android and on iOS, the `addAsync` method isn't supported in Message Compose mode. Only the Appointment Organizer mode is - * supported. For more information on supported APIs in Outlook mobile, see - * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * - In Outlook on Android and on iOS, the `addAsync` method is supported starting in Version 4.2530.0. On these mobile clients, the `addAsync` method isn't + * supported when a user replies from the the reply field at the bottom of a message. * * There's no recipient limit if you call `addAsync` in Outlook on Mac (new UI). * @@ -22333,9 +22332,8 @@ declare namespace Office { * - In Outlook on the web, on Windows, and on Mac (classic UI), you can have a maximum of 500 recipients in a target field. * If you need to add more than 100 recipients to a mail item, you can call `addAsync` repeatedly, but be mindful of the recipient limit of the field. * - * - In Outlook on Android and on iOS, the `addAsync` method isn't supported in Message Compose mode. Only the Appointment Organizer mode is - * supported. For more information on supported APIs in Outlook mobile, see - * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * - In Outlook on Android and on iOS, the `addAsync` method is supported starting in Version 4.2530.0. On these mobile clients, the `addAsync` method isn't + * supported when a user replies from the the reply field at the bottom of a message. * * There's no recipient limit if you call `addAsync` in Outlook on Mac (new UI). * @@ -22397,6 +22395,8 @@ declare namespace Office { * the value of the `recipientType` property for existing recipients isn't updated and will still be based on the domain of the previously selected account. * To get the correct recipient types after switching accounts, you must first remove the existing recipients, then add them back to the mail item. * + * In Outlook on Android and on iOS, only the `getAsync` method is supported when a user replies from the reply field at the bottom of a message. + * * @param options - An object literal that contains one or more of the following properties:- * `asyncContext`: Developers can provide any object they wish to access in the callback function. * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, @@ -22446,6 +22446,8 @@ declare namespace Office { * the value of the `recipientType` property for existing recipients isn't updated and will still be based on the domain of the previously selected account. * To get the correct recipient types after switching accounts, you must first remove the existing recipients, then add them back to the mail item. * + * In Outlook on Android and on iOS, only the `getAsync` method is supported when a user replies from the reply field at the bottom of a message. + * * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, * of type `Office.AsyncResult`. The `asyncResult.value` property of the result is an array of * {@link Office.EmailAddressDetails | EmailAddressDetails} objects. @@ -22472,9 +22474,8 @@ declare namespace Office { * - In Outlook on the web, on Windows (new and classic), and on Mac (classic UI), you can have a maximum of 500 recipients in a target field. * If you need to add more recipients after setting 100 recipients, you can call `addAsync` repeatedly, but be mindful of the recipient limit of the field. * - * - In Outlook on Android and on iOS, the `setAsync` method isn't supported in the Message Compose mode. Only the Appointment Organizer mode is - * supported. For more information on supported APIs in Outlook mobile, see - * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * - In Outlook on Android and on iOS, the `setAsync` method is supported starting in Version 4.2530.0. On these mobile clients, the `setAsync` method isn't + * supported when a user replies from the the reply field at the bottom of a message. * * There's no recipient limit if you call `setAsync` in Outlook on Mac (new UI). * @@ -22515,9 +22516,8 @@ declare namespace Office { * - In Outlook on the web, on Windows (new and classic), and on Mac (classic UI), you can have a maximum of 500 recipients in a target field. * If you need to add more recipients after setting 100 recipients, you can call `addAsync` repeatedly, but be mindful of the recipient limit of the field. * - * - In Outlook on Android and on iOS, the `setAsync` method isn't supported in the Message Compose mode. Only the Appointment Organizer mode is - * supported. For more information on supported APIs in Outlook mobile, see - * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * - In Outlook on Android and on iOS, the `setAsync` method is supported starting in Version 4.2530.0. On these mobile clients, the `setAsync` method isn't + * supported when a user replies from the the reply field at the bottom of a message. * * There's no recipient limit if you call `setAsync` in Outlook on Mac (new UI). * diff --git a/types/office-js/index.d.ts b/types/office-js/index.d.ts index e912483adea951..8ad6e2cdc5d2a5 100644 --- a/types/office-js/index.d.ts +++ b/types/office-js/index.d.ts @@ -21938,9 +21938,8 @@ declare namespace Office { * - In Outlook on the web, on Windows (new and classic), and on Mac (classic UI), you can have a maximum of 500 recipients in a target field. * If you need to add more than 100 recipients to a mail item, you can call `addAsync` repeatedly, but be mindful of the recipient limit of the field. * - * - In Outlook on Android and on iOS, the `addAsync` method isn't supported in Message Compose mode. Only the Appointment Organizer mode is - * supported. For more information on supported APIs in Outlook mobile, see - * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * - In Outlook on Android and on iOS, the `addAsync` method is supported starting in Version 4.2530.0. On these mobile clients, the `addAsync` method isn't + * supported when a user replies from the the reply field at the bottom of a message. * * There's no recipient limit if you call `addAsync` in Outlook on Mac (new UI). * @@ -21978,9 +21977,8 @@ declare namespace Office { * - In Outlook on the web, on Windows (new and classic), and on Mac (classic UI), you can have a maximum of 500 recipients in a target field. * If you need to add more than 100 recipients to a mail item, you can call `addAsync` repeatedly, but be mindful of the recipient limit of the field. * - * - In Outlook on Android and on iOS, the `addAsync` method isn't supported in Message Compose mode. Only the Appointment Organizer mode is - * supported. For more information on supported APIs in Outlook mobile, see - * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * - In Outlook on Android and on iOS, the `addAsync` method is supported starting in Version 4.2530.0. On these mobile clients, the `addAsync` method isn't + * supported when a user replies from the the reply field at the bottom of a message. * * There's no recipient limit if you call `addAsync` in Outlook on Mac (new UI). * @@ -22042,6 +22040,8 @@ declare namespace Office { * the value of the `recipientType` property for existing recipients isn't updated and will still be based on the domain of the previously selected account. * To get the correct recipient types after switching accounts, you must first remove the existing recipients, then add them back to the mail item. * + * In Outlook on Android and on iOS, only the `getAsync` method is supported when a user replies from the reply field at the bottom of a message. + * * @param options - An object literal that contains one or more of the following properties:- * `asyncContext`: Developers can provide any object they wish to access in the callback function. * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, @@ -22091,6 +22091,8 @@ declare namespace Office { * the value of the `recipientType` property for existing recipients isn't updated and will still be based on the domain of the previously selected account. * To get the correct recipient types after switching accounts, you must first remove the existing recipients, then add them back to the mail item. * + * In Outlook on Android and on iOS, only the `getAsync` method is supported when a user replies from the reply field at the bottom of a message. + * * @param callback - When the method completes, the function passed in the `callback` parameter is called with a single parameter, `asyncResult`, * of type `Office.AsyncResult`. The `asyncResult.value` property of the result is an array of * {@link Office.EmailAddressDetails | EmailAddressDetails} objects. @@ -22117,9 +22119,8 @@ declare namespace Office { * - In Outlook on the web, on Windows (new and classic), and on Mac (classic UI), you can have a maximum of 500 recipients in a target field. * If you need to add more recipients after setting 100 recipients, you can call `addAsync` repeatedly, but be mindful of the recipient limit of the field. * - * - In Outlook on Android and on iOS, the `setAsync` method isn't supported in the Message Compose mode. Only the Appointment Organizer mode is - * supported. For more information on supported APIs in Outlook mobile, see - * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * - In Outlook on Android and on iOS, the `setAsync` method is supported starting in Version 4.2530.0. On these mobile clients, the `setAsync` method isn't + * supported when a user replies from the the reply field at the bottom of a message. * * There's no recipient limit if you call `setAsync` in Outlook on Mac (new UI). * @@ -22160,9 +22161,8 @@ declare namespace Office { * - In Outlook on the web, on Windows (new and classic), and on Mac (classic UI), you can have a maximum of 500 recipients in a target field. * If you need to add more recipients after setting 100 recipients, you can call `addAsync` repeatedly, but be mindful of the recipient limit of the field. * - * - In Outlook on Android and on iOS, the `setAsync` method isn't supported in the Message Compose mode. Only the Appointment Organizer mode is - * supported. For more information on supported APIs in Outlook mobile, see - * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-mobile-apis | Outlook JavaScript APIs supported in Outlook on mobile devices}. + * - In Outlook on Android and on iOS, the `setAsync` method is supported starting in Version 4.2530.0. On these mobile clients, the `setAsync` method isn't + * supported when a user replies from the the reply field at the bottom of a message. * * There's no recipient limit if you call `setAsync` in Outlook on Mac (new UI). *